Skip to content

Latest commit

 

History

History
95 lines (62 loc) · 2.72 KB

install-addons.md

File metadata and controls

95 lines (62 loc) · 2.72 KB
Raw
title
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:

yarn add -D @storybook/addon-a11y

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

<CodeSnippets paths={[ 'common/storybook-main-addon-registration.js.mdx', ]} />

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 it's 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:

<CodeSnippets paths={[ 'common/storybook-preset-scss.webpack-4.js.mdx', 'common/storybook-preset-scss.webpack-5.js.mdx', ]} />

💡 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 to the following:

<CodeSnippets paths={[ 'common/storybook-main-preset-config.js.mdx', ]} />

Now when you run Storybook it will configure itself to use SCSS styling. No further configuration 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:

<CodeSnippets paths={[ 'common/storybook-preset-configuration.js.mdx', ]} />

Preset addons may also have addon-specific configuration. 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.