Skip to content
This repository has been archived by the owner on Nov 15, 2022. It is now read-only.

Latest commit

 

History

History
105 lines (71 loc) · 2.91 KB

backgrounds.md

File metadata and controls

105 lines (71 loc) · 2.91 KB
Raw
title
Backgrounds

The backgrounds toolbar addon allows you to set the background color in which the story renders in the UI:

Configuration

By default, the backgrounds toolbar includes a light and dark background.

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

<CodeSnippets paths={[ 'common/storybook-preview-configure-background-colors.js.mdx', ]} />

If you define the default property, the addon will apply it to all stories. Otherwise, it's only listed as an available color.

Extending the configuration

You can also define backgrounds per-component or per-story basis through parameter inheritance:

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

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

<CodeSnippets paths={[ 'common/storybook-addon-backgrounds-override-background-color.js.mdx', 'common/storybook-addon-backgrounds-override-background-color.mdx.mdx', ]} />

Disable backgrounds

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

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

Grid

Backgrounds toolbar also includes a Grid selector. This way, you can quickly see if your components are aligned.

You don't need additional configuration to get started. But its properties are fully customizable, if you don't supply any value to any of its properties, they'll default to the following values:

<CodeSnippets paths={[ 'common/storybook-addon-backgrounds-configure-grid.js.mdx', 'common/storybook-addon-backgrounds-configure-grid.mdx.mdx', ]} />

Disable the grid

If you need to disable the grid for a specific story, set the backgrounds parameter to the following:

<CodeSnippets paths={[ 'common/storybook-addon-backgrounds-disable-grid.js.mdx', 'common/storybook-addon-backgrounds-disable-grid.mdx.mdx', ]} />