Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add info about Lit in migration guide #15029

Merged
merged 2 commits into from
May 25, 2021
Merged

Add info about Lit in migration guide #15029

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a41cf6
docs: add a section about Lit support in 6.2 -> 6.3 migration guide
gaetanmaisse May 25, 2021
1306925
docs: fix code snippet types and make npm/yarn snippet consistent
gaetanmaisse May 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions MIGRATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
- [From version 6.2.x to 6.3.0](#from-version-62x-to-630)
- [Webpack 5 manager build](#webpack-5-manager-build)
- [Angular 12 upgrade](#angular-12-upgrade)
- [Lit support](#lit-support)
- [6.3 deprecations](#63-deprecations)
- [Deprecated scoped blocks imports](#deprecated-scoped-blocks-imports)
- [Deprecated `argType.defaultValue`](#deprecated-argtypedefaultvalue)
Expand Down Expand Up @@ -167,16 +168,20 @@ Storybook 6.2 introduced **experimental** webpack5 support for building user com

If you're upgrading from 6.2 and already using the experimental webpack5 feature, this might be a breaking change (hence the 'experimental' label) and you should try adding the manager builder:

```
```shell
yarn add @storybook/manager-webpack5 --dev
# Or
npm install @storybook/manager-webpack5 --save-dev
```

### Angular 12 upgrade

Storybook 6.3 supports Angular 12 out of the box when you install it fresh. However, if you're upgrading your project from a previous version, you'll need to do the following steps to force Storybook to use webpack 5 for building your project:

```js
npm install @storybook/builder-webpack5 --save-dev # or yarn
```shell
yarn add @storybook/builder-webpack5 --dev
# Or
npm install @storybook/builder-webpack5 --save-dev
```

Then edit your `.storybook/main.js` config:
Expand All @@ -189,6 +194,14 @@ module.exports = {
};
```

### Lit support

Storybook 6.3 introduces Lit 2 support in a non-breaking way to ease migration from `lit-html`/`lit-element` to `lit`.

To do so, it relies on helpers added in the latest minor versions of `lit-html`/`lit-element`. So when upgrading to Storybook 6.3, please ensure your project is using `lit-html` 1.4.x or `lit-element` 2.5.x.

According to the package manager you are using, it can be handled automatically when updating Storybook or can require to manually update the versions and regenerate the lockfile.

### 6.3 deprecations

#### Deprecated scoped blocks imports
Expand Down