New
You're viewing older docs for version 6.3. View latest docs

Sidebar & URLS

Storybook’s sidebar lists all your stories grouped by component. When you have a lot of components you may wish to also 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:

Storybook sidebar anatomy

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 are displayed as folders:

Storybook sidebar story roots

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:

Generating titles based on __dirname

As a CSF file is a JavaScript file, the exports (including the default export) can be generated dynamically. In particular you can use the __dirname variable to generate the title based on the path name (this example uses the paths.macro):

Permalinking 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 (especially when you publish your Storybook).

Consider the following 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 id of a story, which in particular is useful 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:

Storybook will prioritize the id over the title for ID generation, if provided, and will prioritize the story.name over the export key for display.

Was this page helpful?

Markdown accepted ([link text](url), _italic_, **bold**, etc). Your anonymous feedback will be posted publicly on GitHub.

✍️ Edit on GitHub – PRs welcome!
Storybook
Join the community
6,612 developers and counting
WhyWhy StorybookComponent-driven UI
DocsGuidesTutorialsChangelogTelemetryStatus
CommunityAddonsGet involvedBlog
ShowcaseExploreProjectsComponent glossary
Open source software
Storybook

Maintained by
Chromatic
Special thanks to Netlify and CircleCI