mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-04 21:51:17 +08:00
30 lines
1019 B
Markdown
30 lines
1019 B
Markdown
# Storybook Addon Backgrounds
|
|
|
|
Storybook Addon Backgrounds can be used to change background colors inside the preview in [Storybook](https://storybook.js.org).
|
|
|
|
[Framework Support](https://storybook.js.org/docs/react/api/frameworks-feature-support)
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
Backgrounds is part of [essentials](https://storybook.js.org/docs/react/essentials/introduction) and so is installed in all new Storybooks by default. If you need to add it to your Storybook, you can run:
|
|
|
|
```sh
|
|
npm i -D @storybook/addon-backgrounds
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Then, add following content to [`.storybook/main.js`](https://storybook.js.org/docs/react/configure/overview#configure-your-storybook-project):
|
|
|
|
```js
|
|
module.exports = {
|
|
addons: ['@storybook/addon-backgrounds'],
|
|
};
|
|
```
|
|
|
|
## Usage
|
|
|
|
The usage is documented in the [documentation](https://storybook.js.org/docs/react/essentials/backgrounds).
|