Migration guide for Storybook 9.0

Storybook 9 improves performance, compatibility, and stability. Its key features include:

• 🔋 Storybook Test, a batteries-included testing tool in your Storybook
• 🧪 Component testing
• ♿️ Accessibility testing
• 🛡️ Test coverage
• 🪶 48% lighter bundle
• ⚛️ React Native for device and web
• 🏷️ Tags-based story organization

This guide is meant to help you upgrade from Storybook 8.x to 9.0 successfully!

Major breaking changes

The rest of this guide will help you upgrade successfully, either automatically or manually. But first, there are some breaking changes in Storybook 9. Here are the most impactful changes you should know about before you go further:

• Packages have been consolidated/removed
• Essential addons moved to core
• Test addon renamed from experimental-addon-test to addon-vitest
• nextjs-vite framework stabilized
• Removed Webpack builder support for Preact, Vue, and Web Components in favor of Vite
• Manager builder removed alias for util, assert and process
• Ecosystem updates
  • Node 20+ is now required
  • Angular 18+ is now required
  • Lit v3+ is now required
  • Next.js 14+ is now required
  • Svelte 5+ is now required
  • Vite 5+ is now required
  • Vitest 3+ is now required
  • npm 10+ is now required
  • pnpm 9+ is now required
  • yarn 4+ is now required
  • TypeScript 4.9+ is now required

If any of these changes apply to your project, please read through the linked migration notes before continuing.

If any of these new requirements or changes are blockers for your project, we recommend to continue using Storybook 8.x.

You may wish to read the full migration notes before migrating. Or you can run the upgrade command below and we’ll try to take care of everything for you!

Automatic upgrade

To upgrade your Storybook:

npx storybook@next upgrade

This will:

1. Determine that none of the breaking changes apply to your project
   • If they do, you will receive instructions on how to resolve them before continuing
2. Upgrade your Storybook dependencies to the latest version
3. Run a collection of automigrations, which will:
   • Check for common upgrade tasks
   • Explain the necessary changes with links to more information
   • Ask for approval, then perform the task automatically on your behalf

New projects

To add Storybook to a project that isn’t currently using Storybook:

npm create storybook@latest

This will:

1. Figure out which renderer (React, Vue, Angular, Web Components), builder (Webpack, Vite), or meta-framework (Next.js, SvelteKit) you’re using
2. Install Storybook 9 and auto-configure it to mirror project settings

Troubleshooting

The automatic upgrade should get your Storybook into a working state. If you encounter an error running Storybook after upgrading, here’s what to do:

1. Try running the doctor command to check for common issues (such as duplicate dependencies, incompatible addons, or mismatched versions) and see suggestions for fixing them.
2. If you’re running storybook with the dev command, try using the build command instead. Sometimes build errors are more legible than dev errors!
3. Check the full migration notes, which contains an exhaustive list of noteworthy changes in Storybook 9. Many of these are already handled by automigrations when you upgrade, but not all are. It’s also possible that you’re experiencing a corner case that we’re not aware of.
4. Search Storybook issues on GitHub. If you’re seeing a problem, there’s a good chance other people are too. If so, upvote the issue, try out any workarounds described in the comments, and comment back if you have useful info to contribute.
5. If there’s no existing issue, you can file one, ideally with a reproduction attached. We’ll be on top of Storybook 9 issues as we’re stabilizing the release.

If you prefer to debug yourself, here are a few useful things you can do to help narrow down the problem:

1. Try removing all addons that are not in the @storybook npm namespace (make sure you don't remove the storybook package). Community addons that work well with 8.x might not yet be compatible with 9.0, and this is the fastest way to isolate that possibility. If you find an addon that needs to be upgraded to work with Storybook 9, please post an issue on the addon’s repository, or better yet, a pull request to upgrade it!
2. Another debugging technique is to bisect to older prerelease versions of Storybook to figure out which release broke your Storybook. For example, assuming that the current prerelease of Storybook is 9.0.0-beta.56, you could set the version to 9.0.0-alpha.0 in your package.json and reinstall to verify that it still works (alpha.0 should be nearly identical to 8.6.x). If it works, you could then try 9.0.0-beta.0, then 9.0.0-beta.28 and so forth. Once you’ve isolated the bad release, read through its CHANGELOG entry and perhaps there’s a change that jumps out as the culprit. If you find the problem, please submit an issue or pull request to the Storybook monorepo and we’ll do our best to take care of it quickly.

Package structure changes

The following packages are no longer published. Instead they have been consolidated into Storybook's core package, storybook. If a consolidated package had exports, those are available via the replacement path in the table below. See the full migration notes for details.

The following packages have been consolidated and moved into an internal path to indicate that they are now for internal usage only. They will continue to work in 9.x releases, but will likely be removed in 10.0. See the full migration notes for details.

Addon authors may continue to use the internal packages, there is currently not yet any replacement.

Optional migrations

In addition to the automigrations and manual migrations above, there are also optional migrations that you should consider. These are features that we’ve deprecated in Storybook 9 (but remain backwards compatible), or best practices that should help you be more productive in the future.

test-runner to addon-vitest

addon-vitest and the rest of the Storybook Test experience is designed to supercede the test-runner. It's faster and provides a better experience for writing and running tests. If your project uses React, Vue, or Svelte and is built with Vite, you should consider migrating to addon-vitest, by following the installation instructions.

CSF 2 to CSF 3

There are many good reasons to convert your stories from CSF 2 to CSF 3. We provide a codemod which, in most cases, should automatically make the code changes for you (make sure to update the glob to fit your files):

# Convert CSF 2 to CSF 3
npx storybook@latest migrate csf-2-to-3 --glob="**/*.stories.tsx" --parser=tsx