7.2 KiB
| title |
|---|
| Sidebar & URLS |
Storybook’s sidebar lists all your stories grouped by component. When you have many components, you may also wish to group those components. To do so, you can add the / separator to the title of your CSF file, and Storybook will group the stories into groups based on common prefixes:
We recommend using a nesting scheme that mirrors the filesystem path of the components. For example, if you have a file components/modals/Alert.js, name the CSF file components/modals/Alert.stories.js and title it Components/Modals/Alert.
Roots
By default, Storybook will treat your top-level nodes as “roots”. Roots are displayed in the UI as “sections” of the hierarchy. Lower level groups will show up as folders:
If you’d prefer to show top-level nodes as folders rather than roots, you can set the sidebar.showRoots option to false in ./storybook/manager.js:
<CodeSnippets paths={[ 'common/storybook-manager-disable-roots.js.mdx', ]} />
Permalink to stories
By default, Storybook generates an id for each story based on the component title and the story name. This id in particular is used in the URL for each story, and that URL can serve as a permalink (primarily when you publish your Storybook).
Consider the following story:
<CodeSnippets paths={[ 'common/foo-bar-baz-story.js.mdx', 'common/foo-bar-baz-story.ts.mdx', ]} usesCsf3 csf2Path="configure/sidebar-and-urls#snippet-foo-bar-baz-story" />
Storybook's ID-generation logic will give this the id foo-bar--baz, so the link would be ?path=/story/foo-bar--baz.
It is possible to manually set the story's id, which is helpful if you want to rename stories without breaking permalinks. Suppose you want to change the position in the hierarchy to OtherFoo/Bar and the story name to Moo. Here's how to do that:
<CodeSnippets paths={[ 'common/other-foo-bar-story.js.mdx', 'common/other-foo-bar-story.ts.mdx', ]} usesCsf3 csf2Path="configure/sidebar-and-urls#snippet-other-foo-bar-story" />
Storybook will prioritize the id over the title for ID generation if provided and prioritize the story.name over the export key for display.
CSF 3.0 auto-titles
Storybook 6.4 introduced CSF 3.0 as an experimental feature, allowing you to write stories more compactly. Suppose you're already using this format to write your stories. In that case, you can omit the title element from the default export and allow Storybook automatically infer it based on the file's physical location. For example, given the following configuration and story:
<CodeSnippets paths={[ 'common/storybook-main-configuration-src-dir.main-js.js.mdx', 'common/storybook-main-configuration-src-dir.main-ts.ts.mdx', 'common/component-story-auto-title.csf3-story.js.mdx', 'common/component-story-auto-title.csf3-story-ts.ts.mdx', ]} />
When Storybook loads, the story can show up in the sidebar as components/My Component.
Auto-title filename case
Starting with Storybook 6.5, story titles generated automatically no longer rely on Lodash's startCase.
Instead, the file name casing is preserved, allowing additional control over the story title. For example, components/My Component will be defined as components/MyComponent.
If you need, you can revert to the previous pattern by adding the following configuration:
<CodeSnippets paths={[ 'common/storybook-manager-render-label-stories.js.mdx', ]} />
Auto-title redundant filenames
In addition to improvements to the story file name casing, a new heuristic was introduced, removing redundant names in case the filename has the same name as the directory name, or if it's called index.stories.js|ts. For example, before components/MyComponent/MyComponent.stories.js was defined as Components/MyComponent/MyComponent in the sidebar. Now it will be defined as Components/MyComponent.
If you need to preserve the naming scheme, you can add the title element to the default export. For example:
<CodeSnippets paths={[ 'common/storybook-csf-3-auto-title-redundant.js.mdx', 'common/storybook-csf-3-auto-title-redundant.ts.mdx', ]} usesCsf3 />
Auto-title prefixes
Additionally, if you customize your Storybook to load your stories based on a configuration object, including a titlePrefix, Storybook automatically prefixes all titles to matching stories. For example, assuming you have the following configuration:
<CodeSnippets paths={[ 'common/storybook-main-auto-title-custom.js.mdx', 'common/storybook-main-auto-title-custom.ts.mdx', ]} />
When Storybook generates the titles for all matching stories, they'll retain the Custom prefix.
Story Indexers
Story Indexers are usually responsible of crawling through your filesystem on your given glob path, and retrieve the stories that match that glob, afterwards Storybook analyzes these stories and create entries for these stories in the index.json (formerly stories.json). This index.json is used to populate the sidebar links based on the title retrieved for each story from the story file.
For CSF, it is either auto generated or retrieved from the meta configuration.
<CodeSnippets paths={[ 'common/csf-3-example-title.ts.mdx', ]} />
While for "Docs Only" pages, that title resides in the title attribute of the Meta tag. If the title attribute does not exist, Storybook indexer will be looking for the of attribute to retrieve a CSF story and get the title from there.
<CodeSnippets paths={[ 'common/storybook-auto-docs-mdx-docs-docs-only-page.mdx.mdx', ]} />
Typically Storybook provides indexing capabilities for files that end with .(story|stories).@(js|ts|jsx|tsx|mdx). If you feel the need to include stories that have different naming convention, e.g. 20478, you will need to introduce a new story indexer.
<CodeSnippets paths={[ 'common/storybook-main-csf-indexer.js.mdx', ]} />
Another example listed below for indexing .md & .html files which is already implemented by one of our community addons Markdown Docs.
<CodeSnippets paths={[ 'common/storybook-main-md-html-indexer.js.mdx', ]} />