| title |
|---|
Component Story Format (CSF) |
Component Story Format (CSF) is the recommended way to write stories. It's an open standard based on ES6 modules that is portable beyond Storybook.
If you are writing stories in the older storiesOf() syntax, you can find documentation in an advanced README.
In CSF, stories and component metadata are defined as ES Modules. Every component story file consists of a required default export and one or more named exports.
CSF is supported in all frameworks except React Native, where you should use the storiesOf API instead.
The default export defines metadata about your component, including the component itself, its title (where it will show up in the navigation UI story hierarchy), decorators, and parameters.
The component field is optional (but encouraged!), and is used by addons for automatic prop table generation and display of other component metadata. title should be unique, i.e. not re-used across files.
<CodeSnippets paths={[ 'common/my-component-story-mandatory-export.js.mdx', ]} />
For more examples, see writing stories.
With CSF, every named export in the file represents a story function by default.
<CodeSnippets paths={[ 'react/my-component-story-basic-and-props.js.mdx', 'vue/my-component-story-basic-and-props.js.mdx', 'svelte/my-component-story-basic-and-props.js.mdx', 'svelte/my-component-story-basic-and-props.native-format.mdx', ]} />
The exported identifiers will be converted to "start case" using Lodash's startCase function. For example:
| Identifier | Transformation |
|---|---|
| name | Name |
| someName | Some Name |
| someNAME | Some NAME |
| some_custom_NAME | Some Custom NAME |
| someName1234 | Some Name 1 2 3 4 |
It's recommended to start export names with a capital letter.
Story functions can be annotated with a few different fields to define story-level decorators and parameters, and also to define the storyName of the story.
The storyName is useful if you want to use names with special characters, names that correspond to restricted keywords in Javascript, or names that collide with other variables in the file. If it's not specified, the export name will be used instead.
<CodeSnippets paths={[ 'common/my-component-story-with-storyname.js.mdx', ]} />
Starting in SB 6.0, stories accept named inputs called Args. Args are dynamic data that are provided (and possibly updated by) Storybook and its addons.
Consider Storybook’s "Button" example of a text button that logs its click events:
<CodeSnippets paths={[ 'react/button-story-click-handler.js.mdx', 'vue/button-story-click-handler.2.js.mdx', 'vue/button-story-click-handler.3.js.mdx', 'svelte/button-story-click-handler.js.mdx', 'svelte/button-story-click-handler.native-format.mdx', ]} />
Now consider the same example, re-written with args:
<CodeSnippets paths={[ 'react/button-story-click-handler-args.js.mdx', 'vue/button-story-click-handler-args.2.js.mdx', 'vue/button-story-click-handler-args.3.js.mdx', ]} />
At first blush this might seem no better than the original example. However, if we add the Docs addon and configure the Actions addon appropriately, we can write:
<CodeSnippets paths={[ 'react/button-story-click-handler-simple-docs.js.mdx', 'vue/button-story-click-handler-simple-docs.2.js.mdx', 'vue/button-story-click-handler-simple-docs.3.js.mdx', ]} />
Or even more simply:
<CodeSnippets paths={[ 'react/button-story-click-handler-simplificated.js.mdx', ]} />
Not only are these versions shorter and easier to write than their no-args counterparts, but they are also more portable since the code doesn't depend on the actions addon specifically.
For more information on setting up Docs and Actions, see their respective documentation.
Storybook handles named exports and story.name slightly differently. When should you use one vs. the other?
The named export is always used to determine the story ID / URL.
If you specify story.name, it will be used as the story display name in the UI.
If you don't specify story.name, the named export will be used to generate the display name. Storybook passes the named export through a storyNameFromExport function, which is implemented with lodash.startCase:
<CodeSnippets paths={[ 'common/storybook-test-with-storyname.js.mdx', ]} />
When you want to change the name of your story, just rename the CSF export. This will change the name of the story and also change the story's ID and URL.
You should use the story.name option in the following cases:
- You want the name to show up in the Storybook UI in a way that's not possible with a named export, e.g. reserved keywords like "default", special characters like emoji, spacing/capitalization other than what's provided by
storyNameFromExport. - You want to preserve the Story ID independently from changing how it's displayed. Having stable Story ID's is useful for integration with third party tools.
In some cases, you may want to export a mixture of story and non-stories. For example, it can be useful to export data that's used in your stories.
To make this possible, you can use optional includeStories and excludeStories configuration fields in the default export, which can be set to either an array of strings, or a regular expression.
Consider the following story file:
<CodeSnippets paths={[ 'react/my-component-story-with-nonstory.js.mdx', 'vue/my-component-story-with-nonstory.js.mdx', 'svelte/my-component-story-with-nonstory.js.mdx', ]} />
When Storybook loads this file, it will see all the exports, but it will ignore the data exports and only treat SimpleStory and ComplexStory as stories.
For this specific example the equivalent result can be achieved in a few ways depending on what's convenient:
includeStories: /^[A-Z]/includeStories: /.*Story$/includeStories: ['SimpleStory', 'ComplexStory']excludeStories: /^[a-z]/excludeStories: /.*Data$/excludeStories: ['simpleData', 'complexData']
If you follow the best practice of starting story exports with an uppercase letter (i.e. use UpperCamelCase), the first option is the recommended solution.