| 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.ts file to go along with it. It might look something like this:
<CodeSnippets paths={[ 'react/your-component.js.mdx', 'react/your-component.ts.mdx', 'angular/your-component.ts.mdx', 'vue/your-component.2.js.mdx', 'vue/your-component.2.ts.mdx', 'vue/your-component.3.js.mdx', 'vue/your-component.3.ts.mdx', 'web-components/your-component.js.mdx', 'web-components/your-component.ts.mdx', 'svelte/your-component.js.mdx', 'html/your-component.js.mdx', 'html/your-component.ts.mdx', 'preact/your-component.js.mdx', ]} usesCsf3 csf2Path="get-started/setup#snippet-your-component" />
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 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 setup guides for popular tools in the community.
Don't see the tool that you're looking for? Check out the styling and css page for more details.
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 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 evergreen browsers, 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 Fontawesome, 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.ts.mdx', 'vue/storybook-preview-with-library-decorator.library-2.js.mdx', 'vue/storybook-preview-with-library-decorator.library-2.ts.mdx', 'vue/storybook-preview-with-library-decorator.library-3.js.mdx', 'vue/storybook-preview-with-library-decorator.library-3.ts.mdx', 'vue/storybook-preview-with-hoc-component-decorator.component-2.js.mdx', 'vue/storybook-preview-with-hoc-component-decorator.component-2.ts.mdx', 'vue/storybook-preview-with-hoc-component-decorator.component-3.js.mdx', 'vue/storybook-preview-with-hoc-component-decorator.component-3.ts.mdx', 'vue/storybook-preview-with-mixin-decorator.mixin-2.js.mdx', 'vue/storybook-preview-with-mixin-decorator.mixin-2.ts.mdx', 'angular/storybook-preview-with-styled-components-decorator.ts.mdx', ]} />
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.