Skip to content

Latest commit

 

History

History
214 lines (142 loc) · 13 KB

overview.md

File metadata and controls

214 lines (142 loc) · 13 KB
Raw
title
Configure Storybook

Storybook is configured via a folder called .storybook, which contains various configuration files.

Note that you can change the folder that Storybook uses by setting the -c flag to your start-storybook and build-storybook scripts.

Configure your Storybook project

The main configuration file is main.js. This file controls the Storybook server's behavior, so you must restart Storybook’s process when you change it. It contains the following:

<CodeSnippets paths={[ 'common/storybook-main-default-setup.js.mdx', ]} />

The main.js configuration file is a preset and, as such, has a powerful interface, but the key fields within it are:

💡 Tip: Customize your default story by referencing it first in the `stories` array.

See all the available fields below if you need further customization.

Feature flags

Additionally, you can also provide additional feature flags to your Storybook configuration. Below is an abridged list of available features that are currently available.

Configuration element Description
storyStoreV7 Configures Storybook to load stories on demand, rather than during boot up.
features: { storyStoreV7: true }
buildStoriesJson Generates a stories.json file to help story loading with the on demand mode.
features: { buildStoriesJson: true }
emotionAlias Provides backwards compatibility for Emotion. See the migration documentation for context.
features: { emotionAlias: false }
babelModeV7 Enables the new Babel configuration mode for Storybook.
features: { babelModeV7: true }
postcss Disables the implicit PostCSS warning. See the migration documentation for context.
features: { postcss: false }
modernInlineRender Enables Storybook's modern inline rendering mode.
features: { modernInlineRender: false }
previewMdx2 Enables experimental support for MDX 2.
features: { previewMdx2: true }

Configure story loading

By default, Storybook will load stories from your project based on a glob (pattern matching string) in .storybook/main.js that matches all files in your project with extension .stories.*. The intention is you colocate a story file with the component it documents.

•
└── components
    ├── Button.js
    └── Button.stories.js

If you want to use a different naming convention, you can alter the glob using the syntax supported by picomatch.

For example, if you wanted to pull both .md and .js files from the my-project/src/components directory, you could write:

<CodeSnippets paths={[ 'common/storybook-main-js-md-files.js.mdx', ]} />

With a configuration object

Additionally, you can customize your Storybook configuration to load your stories based on a configuration object. For example, if you wanted to load your stories from a packages directory, you could adjust your stories configuration field into the following:

<CodeSnippets paths={[ 'common/storybook-storyloading-with-custom-object.js.mdx', ]} />

When Storybook starts, it will look for any file containing the stories extension inside the packages/stories directory and generate the titles for your stories.

With a directory

You can also simplify your Storybook configuration and load the stories based on a directory. For example, if you want to load all the stories inside a packages/MyStories, you can adjust the configuration as such:

<CodeSnippets paths={[ 'common/storybook-storyloading-with-directory.js.mdx', ]} />

With a custom implementation

You can also adjust your Storybook configuration and implement your custom logic for loading your stories. For example, suppose you were working on a project that includes a particular pattern that the conventional ways of loading stories could not solve, in that case, you could adjust your configuration as follows:

<CodeSnippets paths={[ 'common/storybook-storyloading-custom-logic.js.mdx', ]} />

On-demand story loading

As your Storybook grows in size, it gets challenging to load all of your stories in a performant way, slowing down the loading times and yielding a large bundle. Starting with Storybook 6.4, you can optimize your story loading by enabling the storyStoreV7 feature flag in your configuration as follows:

<CodeSnippets paths={[ 'common/storybook-on-demand-story-loading.js.mdx', ]} />

Once you've restarted your Storybook, you'll see an almost immediate performance gain in your loading times and also a decrease in the generated bundle.

Known limitations

This feature is experimental, and it has some limitations on what you can and cannot do in your stories files. If you plan to use it, you'll need to take into consideration the following limitations:

  • CSF formats from version 1 to version 3 are supported. The storiesOf construct is not.
  • CustomstorySort functions are allowed based on a restricted API.

Configure your project with TypeScript

If you would like, you can also write your Storybook configuration using TypeScript. To get started, add a .babelrc file inside your project and include the following Babel presets:

<CodeSnippets paths={[ 'common/storybook-ts-config-babelrc.js.mdx', ]} />

This babel config will be used to process your stories, as well as your config files.

Alternatively, you can install ts-node in your project, which will be used to process your config files without the need for a .babelrc.

Rename your .storybook/main.js to .storybook/main.ts and restart your Storybook.

Using Storybook Types in Your Configuration

You can also use Storybook's TypeScript types to ensure you are using valid options and get autocompletion in your editor. Below is an abridged Storybook configuration with TypeScript types and additional information about each configuration element.

<CodeSnippets paths={[ 'common/storybook-main-default-setup.ts.mdx', ]} />

See the vite builder TypeScript documentation if using @storybook/builder-vite.

Configuration element Description
stories The array of globs that indicates the location of your story files, relative to main.ts
staticDirs Sets a list of directories of static files to be loaded by Storybook
staticDirs:['../public']
addons Sets the list of addons loaded by Storybook
addons:['@storybook/addon-essentials']
typescript Configures how Storybook handles TypeScript files
typescript: { check: false, checkOptions: {} }
framework Configures Storybook based on a set of framework-specific settings
framework:'@storybook/svelte'
core Configures Storybook's internal features.
core: { builder: 'webpack5' }
features Enables Storybook's additional features.
See table below for a list of available features features: { storyStoreV7: true }
refs Configures Storybook composition
refs:{ example: { title: 'ExampleStorybook', url:'https://your-url.com' } }
logLevel Configures Storybook's logs in the browser terminal. Useful for debugging
logLevel: 'debug'
webpackFinal Customize Storybook's Webpack setup
webpackFinal: async (config:any) => { return config; }
viteFinal Customize Storybook's Vite setup when using the vite builder
viteFinal: async (config: Vite.InlineConfig, options: Options) => { return config; }
env Defines custom Storybook environment variables.
env: (config) => ({...config, EXAMPLE_VAR: 'Example var' }),

Configure story rendering

To control the way stories are rendered and add global decorators and parameters, create a .storybook/preview.js file. This is loaded in the Canvas tab, the “preview” iframe that renders your components in isolation. Use preview.js for global code (such as CSS imports or JavaScript mocks) that applies to all stories.

The preview.js file can be an ES module and export the following keys:

If you’re looking to change how to order your stories, read about sorting stories.

Configure Storybook’s UI

To control the behavior of Storybook’s UI (the “manager”), you can create a .storybook/manager.js file.

This file does not have a specific API but is the place to set UI options and to configure Storybook’s theme.