storybook/docs-page.md at 9e483e20c4c3feedf2ca1056baf8d66997336084

mirror of https://github.com/storybookjs/storybook.git synced 2025-04-05 01:11:08 +08:00

2020-08-29 10:09:03 -04:00

6.3 KiB

Raw Blame History

title
DocsPage

When you install Storybook Docs, DocsPage is the zero-config default documentation that all stories get out of the box. It aggregates your stories, text descriptions, docgen comments, args tables, and code examples into a single page for each component.

The best practice for docs is for each component to have its own set of documentation and stories.

Component parameter

Storybook uses the component key in the story file’s default export to extract the component's description and props.

Subcomponents parameter

Sometimes it's useful to document multiple components together. For example, a component library’s ButtonGroup and Button components might not make sense without one another.

DocsPage has the concept of a "primary" component that is defined by the component parameter. It also accepts one or more subcomponents.

Subcomponent ArgsTables will show up in a tabbed interface along with the primary component. The tab titles will correspond to the keys of the subcomponents object.

If you want to organize your documentation differently for component groups, we recommend using MDX. It gives you complete control over display and supports any configuration.

Replacing DocsPage

Replace DocsPage template with your own for the entire Storybook, a specific component, or a specific story.

Override the docs.page parameter:

With null to remove docs.
With MDX docs.
With a custom component

Story-level

Override the docs.page parameter in the story definition.

Component-level

Override the docs.page parameter in the default export of the story file.

Global-level

Override the docs.page parameter in .storybook/preview.js.

Remixing DocsPage using doc blocks

Doc blocks are the basic building blocks of Storybook Docs. DocsPage composes them to provide a reasonable UI documentation experience out of the box.

If you want to make minor customizations to the default DocsPage but don’t want to write your own MDX you can remix DocsPage. That allows you to reorder, add, or omit doc blocks without losing Storybook’s automatic docgen capabilities.

Here's an example of rebuilding DocsPage for the Button component using doc blocks:

Apply a similar technique to remix the DocsPage at the story, component, or global level.

In addition, you can interleave your own components to customize the auto-generated contents of the page, or pass in different options to the blocks to customize their appearance. Read more about Doc Blocks.

Story file names

Unless you use a custom webpack configuration, all of your story files should have the suffix *.stories.@(j|t)sx?. For example, "Badge.stories.js" or "Badge.stories.tsx". This tells Storybook and its docs preset to display the docs based on the file contents.

Inline stories vs. iframe stories

DocsPage displays all the stories of a component in one page. You have the option of rendering those stories inline or in an iframe.

By default, we render React and Vue stories inline. Stories from other supported frameworks will render in an <iframe> by default.

The iframe creates a clean separation between your code and Storybook’s UI. But using an iframe has disadvantages. You have to explicitly set the height of iframe stories or you’ll see a scroll bar. And certain dev tools might not work right.

Render your framework’s stories inline using two docs configuration options in tandem, inlineStories and prepareForInline.

Setting inlineStories to true tells Storybook to stop putting your stories in an iframe. The prepareForInline accepts a function that transforms story content from your given framework to something React can render (Storybook’s UI is built in React).

Different frameworks will need to approach this in different ways. Angular, for example, might convert its story content into a custom element (you can read about that here).

Here’s an example of how to render Vue stories inline. The following docs config block uses prepareForInline along with an effect hook provided by @egoist/vue-to-react.

With this function, anyone using the docs addon for @storybook/vue can make their stories render inline, either globally with the inlineStories docs parameter, or on a per-story-basis using the inline prop on the <Story> doc block.

If you come up with an elegant and flexible implementation for the prepareForInline function for your own framework, let us know. We'd love to make it the default configuration to make inline stories more accessible for a larger variety of frameworks!

6.3 KiB Raw Blame History Unescape Escape