New
You're viewing older docs for version 7.6. View latest docs

Install addons

Storybook has hundreds of reusable addons that are packaged as NPM modules. Let's walk through how to extend Storybook by installing and registering addons.

Using addons

With the exception of preset addons, all addons have the same installation process: install and register.

For example, to include accessibility testing in Storybook, run the following command to install the necessary addon:

Next, update .storybook/main.js|ts to the following:

Addons may also require addon-specific configuration. Read their respective READMEs.

Now when you run Storybook the accessibility testing addon will be enabled.

Storybook addon installed and registered

Using preset addons

Storybook preset addons are grouped collections of specific babel, webpack and addons configurations for distinct use cases. Each one with its own set of instructions. Preset addons have a three-step installation process: install, register and optionally configuration.

For example, to use SCSS styling, run the following command to install the addon and the required dependencies:

Tip:

Use the Webpack 5 snippet only if your framework already includes support for this version. Otherwise, use the Webpack 4 snippet.

Next, update .storybook/main.js|ts to the following:

Now when you run Storybook it will configure itself to use SCSS styling. No further configuration is needed.

Optional configuration

Most preset addons can also take additional parameters. The most common use cases are:

  • Addon configuration
  • Webpack loader configuration

Consider the following example:

Preset addons may also have addon-specific configurations. Read their respective READMEs.

Now, when Storybook starts up, it will update webpack's CSS loader to use modules and adjust how styling is defined.

Was this page helpful?

Markdown accepted ([link text](url), _italic_, **bold**, etc). Your anonymous feedback will be posted publicly on GitHub.

✍️ Edit on GitHub – PRs welcome!
Storybook
Join the community
6,616 developers and counting
WhyWhy StorybookComponent-driven UI
DocsGuidesTutorialsChangelogTelemetryStatus
CommunityAddonsGet involvedBlog
ShowcaseExploreProjectsComponent glossary
Open source software
Storybook

Maintained by
Chromatic
Special thanks to Netlify and CircleCI