Upgrading @storybook/addon-essentials 6 to 7
Breaking6.5.16 → 7.6.24Breaking39Security11Platform10Deprecated5New188Changed288Fixed700Other588
BreakingUpgrade verdict
39 breaking changes and 10 platform requirement changes and 11 security fixes.
In plain terms
- Removes defaultProps in the Stories doc block.
- Renames `index` to `createIndex`.
- Storybook no longer refers to the api package or the two old channel packages that were already deprecated.
- Angular stories can no longer use the old component and propsMeta fields.
Must act Top 5 of 65 that need code or config changes
@storybook/addon-essentials publishes an official migration guide for version 7. It covers more than the release notes do.
Migration guide ↗Adds @storybook/addon-highlight 7.6.24, @storybook/manager-api 7.6.24, @storybook/preview-api 7.6.24.
Drops @storybook/addons, @storybook/api, core-js, regenerator-runtime.
Installs 435 packages in all (was 952).
What you must change
Breaking39
Removes defaultProps in the Stories doc block.
StoriesdefaultPropsRenames
index to createIndex.indexcreateIndexRemoves references to api and the 2 deprecated channel packages.
Angular removes deprecated component and propsMeta from story.
componentpropsMetaRemoves deprecated flags and properties.
Renames the
framework parameter to renderer in Core.frameworkrendererRemoves
DocsOptions.disable.DocsOptions.disableDrops lit1 support for web components.
lit1Removes
svelte-options from Svelte/Vite.svelte-optionsRemoves the deprecated --no-manager-cache CLI flag.
--no-manager-cacheRemoves the deprecated ArgTypes.defaultValue from CSF.
ArgTypes.defaultValueRenames storyByModuleExport to resolveModuleExport in Addon-docs.
storyByModuleExportresolveModuleExportRenames docsPage to autodocs.
docsPageautodocsRenames docsOptions.enabled to docsOptions.disable.
docsOptions.enableddocsOptions.disableRenames the api package to manager-api.
apimanager-apiRenames Framework to Renderer in CSF.
FrameworkRendererPreact now uses inline stories (without iframe) by default in docs.
CLI removes the deprecated -s flag on sb init.
sb init-sRenames storybook/ui to storybook/manager.
storybook/uistorybook/managerRemoves the final batch of deprecated APIs.
Removes deprecated addon APIs.
Removes the onBeforeRender API.
onBeforeRenderRemoves the old showRoots config option.
showRootsRemoves the html entrypoint of lib/components.
lib/componentsRemoves the deprecated Preview component.
PreviewRemoves deprecated channel APIs.
Removes Angular framework storymodule story-component handling.
Removes deprecated glob fixing.
Removes STORYBOOK_REACT_CLASSES and global/globals.ts from Addon-docs.
STORYBOOK_REACT_CLASSESglobal/globals.tsReplaces
config with previewAnnotations and removes previewEntries in Presets.configpreviewAnnotationspreviewEntriesRenames Storybook DOM root IDs.
Removes the docs tab from the UI.
Removes standalone node APIs from Core.
Creates frameworks and renames renderers.
Removes start-storybook and build-storybook from all frameworks.
start-storybookbuild-storybookRemoves experimental components.
Upgrades Addon-docs to MDXv2.
Addon-docsMDXv2Upgrades the build chain to TS4, Webpack5, modern ESM, and TSUP.
Factors out webpack dependencies from core-webpack.
Security11
Hardens websocket connection.
Replaces the ip function to address security concerns.
ipUpdates the ip dependency to fix CVE-2023-42282.
ipUpdates @babel/traverse and @babel/core to fix a vulnerability.
@babel/traverse@babel/coreUpdates the browserify-sign transitive dependency.
browserify-signFilters addon options in telemetry to protect sensitive info.
Upgrades
escodegen to fix a security issue.escodegenFixes the security report around the download-tarball package.
download-tarballFixes a trim vulnerability.
trimUpgrades express to fix a security warning.
expressUpdates x-default-browser and fixes an issue with the package.
x-default-browserPlatform10
Removes the need for
react as a peerDependency.reactMoves typescript from devDependencies to peerDependencies in React.
typescriptRemoves the babel/core peer dependency from Svelte.
@babel/coreMakes vite a peer dependency and updates plugins.
viteAdds an optional TypeScript peer dependency.
TypeScriptExtends the Angular Zone.js peer dependency range.
Zone.jsFixes peer dependencies for npm8, pnpm and yarn PnP.
Adds a Next.js 13 peer dependency.
nextAdds babel loader 9.0.0 to vue-webpack5 peer dependencies.
babel-loadervue-webpack5Makes babel-loader an optional peer dependency for addon-docs.
babel-loaderDeprecations to plan for
Deprecated5
Adds a deprecation notice for Vite with CommonJS.
ViteDeprecates storyStoreV6 (including storiesOf) and storyIndexers.
storyStoreV6storiesOfstoryIndexersDeprecates the key in the addon render function as it is no longer available.
keyRemoves deprecated addPanel use and makes miscellaneous improvements in addons.
addPanelFixes the d.ts file and deprecates LinkTo in addon-links.
LinkTo