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

Backgrounds

The backgrounds toolbar item allows you to adjust the background that your story is rendered on via Storybook’s UI:

Configuration

By default, the backgrounds toolbar presents you with a light and dark background.

But you're not restricted to these two backgrounds, you can configure your own set of colors with the parameters.backgrounds parameter in your .storybook/preview.js:

If you define the default property, the backgrounds toolbar will set that color for every story where the parameter is applied to. If you don't set it, the colors will be available but not automatically set when a story is rendered.

You can also set backgrounds on per-story or per-component basis by using parameter inheritance:

You can also only override a single key on the backgrounds parameter, for instance to set a different default value for a single story:

If you want to disable backgrounds in a story, you can do so by setting the backgrounds parameter like so:

Grid

Backgrounds toolbar also comes with a Grid selector. This way you can easily see if your components are aligned.

By default you don't need to configure anything in order to use it, but the properties of the grid are fully configurable.

Each of these properties have the following default values in case they are not passed:

If you wish to disable the grid in a story, you can do so by setting the backgrounds parameter like so:

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