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

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.

Configuration

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.

Disabling addons

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:

You can use the following keys for each individual addon: actions, backgrounds, controls, docs, viewport, toolbars.

Upgrading from previous versions

If you're upgrading from a previous Storybook version, you will need to add the @storybook/addon-essentials package manually.

In your terminal run the following command:

Terminal
Loading...
If you're using yarn, you'll need to adjust the command accordingly.

Update your Storybook configuration (in .storybook/main.js) to include the essentials addon.

Loading...

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,565 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