| title |
|---|
Setup Storybook |
Now that you’ve learned what stories are and how to browse them, let’s demo working on one of your components.
Pick a simple component from your project, like a Button, and write a .stories.js, or a .stories.mdx file to go along with it. It might look something like this:
<CodeSnippets paths={[ 'react/your-component.js.mdx', 'react/your-component.ts.mdx', 'react/your-component.mdx.mdx', 'angular/your-component.ts.mdx', 'angular/your-component.mdx.mdx', 'vue/your-component.2.js.mdx', 'vue/your-component.mdx-2.mdx.mdx', 'vue/your-component.3.js.mdx', 'vue/your-component.mdx-3.mdx.mdx', 'svelte/your-component.js.mdx', 'svelte/your-component.mdx.mdx', 'web-components/your-component.js.mdx', 'html/your-component.js.mdx', 'html/your-component.ts.mdx', 'preact/your-component.js.mdx', ]} />
Go to your Storybook to view the rendered component. It’s OK if it looks a bit unusual right now.
Depending on your technology stack, you also might need to configure the Storybook environment further.
Storybook comes with a permissive default configuration. It attempts to customize itself to fit your setup. But it’s not foolproof.
Your project may have additional requirements before components can be rendered in isolation. This warrants customizing configuration further. There are three broad categories of configuration you might need.
Build configuration like Webpack and Babel
If you see errors on the CLI when you run the yarn storybook command, you likely need to make changes to Storybook’s build configuration. Here are some things to try:
- Presets bundle common configurations for various technologies into Storybook. In particular, presets exist for Create React App, SCSS and Ant Design.
- Specify a custom Babel configuration for Storybook. Storybook automatically tries to use your project’s config if it can.
- Adjust the Webpack configuration that Storybook uses. Try patching in your own configuration if needed.
Runtime configuration
If Storybook builds but you see an error immediately when connecting to it in the browser, in that case, chances are one of your input files is not compiling/transpiling correctly to be interpreted by the browser. Storybook supports modern browsers and IE11, but you may need to check the Babel and Webpack settings (see above) to ensure your component code works correctly.
Component context
If a particular story has a problem rendering, often it means your component expects a specific environment is available to the component.
A common frontend pattern is for components to assume that they render in a specific “context” with parent components higher up the rendering hierarchy (for instance, theme providers).
Use decorators to “wrap” every story in the necessary context providers. The .storybook/preview.js file allows you to customize how components render in Canvas, the preview iframe. See how you can wrap every component rendered in Storybook with Styled Components ThemeProvider, Vue's Fortawesome, or with an Angular theme provider component in the example below.
<CodeSnippets paths={[ 'react/storybook-preview-with-styled-components-decorator.js.mdx', 'react/storybook-preview-with-styled-components-decorator.story-function.js.mdx', 'vue/storybook-preview-with-library-decorator.2-library.js.mdx', 'vue/storybook-preview-with-library-decorator.3-library.js.mdx', 'vue/storybook-preview-with-hoc-component-decorator.2-component.js.mdx', 'vue/storybook-preview-with-hoc-component-decorator.3-component.js.mdx', 'vue/storybook-preview-with-mixin-decorator.2-mixin.js.mdx', 'vue/storybook-preview-with-mixin-decorator.3-mixin.js.mdx', 'angular/storybook-preview-with-styled-components-decorator.ts.mdx' ]} />
Storybook isn’t opinionated about how you generate or load CSS. It renders whatever DOM elements you provide. But sometimes, things won’t “look right” out of the box.
You may have to configure your CSS tooling for Storybook’s rendering environment. Here are some tips on what could help:
CSS-in-JS like styled-components and Emotion
If you are using CSS-in-JS, chances are your styles are working because they’re generated in JavaScript and served alongside each component. Theme users may need to add a decorator to .storybook/preview.js, see above.
@import CSS into components
Storybook allows you to import CSS files in your components directly. But in some cases you may need to tweak its Webpack configuration. Angular components require a special import.
Global imported styles
If you have global imported styles, create a file called .storybook/preview.js and import the styles there. They will be added by Storybook automatically for all stories.
Add external CSS or webfonts in the <head>
Alternatively, if you want to inject a CSS link tag to the <head> directly (or some other resource like a webfont link), you can use .storybook/preview-head.html to add arbitrary HTML.
Load fonts or images from a local directory
If you're referencing fonts or images from a local directory, you'll need to configure the Storybook script to serve the static files.
If you want to link to static files in your project or stories (e.g., /fonts/XYZ.woff), use the -s path/to/folder flag to specify a static folder to serve from when you start up Storybook. To do so, edit the storybook and build-storybook scripts in package.json.
We recommend serving external resources and assets requested in your components statically with Storybook. It ensures that assets are always available to your stories.