GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-05 16:11:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update MIGRATION.md

Browse Source
This commit is contained in:
Tom Coleman 2021-10-20 15:22:30 +11:00 committed by GitHub
parent 5d6d413609
commit bae4521c59
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
MIGRATION.md
View File

@ -9,6 +9,7 @@
- [Behavioral differences](#behavioral-differences)
- [Using the v7 store](#using-the-v7-store)
- [V7-style story sort](#v7-style-story-sort)
- [Store API changes for addon authors](#store-api-changes-for-addon-authors)
- [Babel mode v7](#babel-mode-v7)
- [Loader behavior with args changes](#loader-behavior-with-args-changes)
- [Angular component parameter removed](#angular-component-parameter-removed)
@ -332,6 +333,14 @@ function storySort(a, b) {
},
```
#### Store API changes for addon authors
The Story Store in v7 mode is async, so syncronous story loading APIs no longer work. In particular:
- `store.fromId()` has been replaced by `store.loadStory()`, which is async (i.e. returns a `Promise` you will need to await).
- `store.raw()/store.extract()` and friends that list all stories require a prior call to `store.cacheAllCSFFiles()` (which is async). This will load all stories, and isn't generally a good idea in an addon, as it will force the whole store to load.
### Babel mode v7
SB6.4 introduces an opt-in feature flag, `features.babelModeV7`, that reworks the way Babel is configured in Storybook to make it more consistent with the Babel is configured in your app. This breaking change will become the default in SB 7.0, but we encourage you to migrate today.