title |
---|
Essential addons |
A major strength of Storybook are addons that extend Storybook’s UI and behavior. There are many third-party addons as well as “official” addons developed by the Storybook core team. Storybook ships by default with a set of “essential” addons that add to the initial user experience.
If you're running sb init
to add Storybook to your project, the essentials package (@storybook/addon-essentials
) is already installed and configured for you . You can skip the rest of this section.
If you're upgrading from a previous Storybook version, you'll need to run the following command in your terminal:
npm install --save-dev @storybook/addon-essentials
Update your Storybook configuration (in .storybook/main.js
) to include the essentials addon.
module.exports = {
addons: ['@storybook/addon-essentials'],
};
Essentials is "zero config”, it comes with a recommended configuration out of the box.
If you need to reconfigure any of the essential addons, install it manually, following the installation instructions and adjust the configuration to your needs.
When you start Storybook, Essentials will override its configuration with your own.
If you need to disable any of the Essential's addons, you can do it by changing your .storybook/main.js
file.
As an example, if the background addon wasn't necessary to your work, you would need to make the following change:
<CodeSnippets paths={[ 'common/storybook-main-disable-addon.js.mdx', ]} />
You can use the following keys for each individual addon: actions
, backgrounds
, controls
, docs
, viewport
, toolbars
.