Skip to content
This repository has been archived by the owner on Jan 6, 2024. It is now read-only.

Latest commit

 

History

History
357 lines (255 loc) · 14.2 KB

recipes.md

File metadata and controls

357 lines (255 loc) · 14.2 KB
Raw

Storybook Docs Recipes

Storybook Docs consists of two basic mechanisms, DocsPage and MDX. But how should you use them in your project?

Component Story Format (CSF) with DocsPage

Storybook's Component Story Format (CSF) is a convenient, portable way to write stories. DocsPage is a convenient, zero-config way to get rich docs for CSF stories. Using these together is a primary use case for Storybook Docs.

If you want to intersperse longform documentation in your Storybook, for example to include an introductory page at the beginning of your storybook with an explanation of your design system and installation instructions, Documentation-only MDX is a good way to achieve this.

Pure MDX Stories

MDX is an alternative syntax to CSF that allows you to co-locate your stories and your documentation. Everything you can do in CSF, you can do in MDX. And if you're consuming it in Webpack, it exposes an identical interface, so the two files are interchangeable. Some teams will choose to write all of their Storybook in MDX and never look back.

CSF Stories with MDX Docs

Perhaps you want to write your stories in CSF, but document them in MDX? Here's how to do that:

Button.stories.js

import React from 'react';
import { Button } from './Button';

// NOTE: no default export since `Button.stories.mdx` is the story file for `Button` now
//
// export default {
//   title: 'Demo/Button',
//   component: Button,
// };

export const basic = () => <Button>Basic</Button>;
basic.parameters = {
  foo: 'bar',
};

Button.stories.mdx

import { Meta, Story } from '@storybook/addon-docs';
import \* as stories from './Button.stories.js';
import { Button } from './Button';
import { SomeComponent } from 'path/to/SomeComponent';

<Meta title="Demo/Button" component={Button} />

# Button

I can define a story with the function imported from CSF:

<Story story={stories.basic} />

And I can also embed arbitrary markdown & JSX in this file.

<SomeComponent prop1="val1" />

What's happening here:

  • Your stories are defined in CSF, but because of includeStories: [], they are not actually added to Storybook.
  • The named story exports are annotated with story-level decorators, parameters, args, and the <Story story={}> construct respects this.
  • All component-level decorators, parameters, etc. from Button.stories default export must be manually copied over into <Meta> if desired.

CSF Stories with arbitrary MDX

We recommend MDX Docs as the most ergonomic way to annotate CSF stories with MDX. There's also a second option if you want to annotate your CSF with arbitrary markdown:

Button.mdx

import { Story } from '@storybook/addon-docs';
import { SomeComponent } from 'somewhere';

# Button

I can embed a story (but not define one, since this file should not contain a `Meta`):

<Story id="some--id" />

And I can also embed arbitrary markdown & JSX in this file.

<SomeComponent prop1="val1" />

Button.stories.js

import React from 'react';
import { Button } from './Button';
import mdx from './Button.mdx';
export default {
  title: 'Demo/Button',
  parameters: {
    docs: {
      page: mdx,
    },
  },
  component: Button,
};
export const basic = () => <Button>Basic</Button>;

Note that in contrast to other examples, the MDX file suffix is .mdx rather than .stories.mdx. This key difference means that the file will be loaded with the default MDX loader rather than Storybook's CSF loader, which has several implications:

  1. You shouldn't provide a Meta declaration.
  2. You can refer to existing stories (i.e. <Story id="...">) but cannot define new stories (i.e. <Story name="...">).
  3. The documentation gets exported as the default export (MDX default) rather than as a parameter hanging off the default export (CSF).

Mixing storiesOf with CSF/MDX

You might have a collection of stories using the storiesOf API and want to add CSF/MDX piecemeal. Or you might have certain stories that are only possible with the storiesOf API (e.g. dynamically generated ones)

So how do you mix these two types? The first argument to configure can be a require.context "req", an array of req's, or a loader function. The loader function should either return null or an array of module exports that include the default export. The default export is used by configure to load CSF/MDX files.

So here's a naive implementation of a loader function that assumes that none of your storiesOf files contains a default export, and filters out those exports:

const loadFn = () => {
  const req = require.context('../src', true, /\.stories\.js$/);
  return req
    .keys()
    .map((fname) => req(fname))
    .filter((exp) => !!exp.default);
};

configure(loadFn, module);

We could have baked this heuristic into Storybook, but we can't assume that your storiesOf files don't have default exports. If they do, you can filter them some other way (e.g. by file name).

If you don't filter out those files, you'll see the following error:

"Loader function passed to 'configure' should return void or an array of module exports that all contain a 'default' export"

We made this error explicit to make sure you know what you're doing when you mix storiesOf and CSF/MDX.

Migrating from notes/info addons

If you're currently using the notes/info addons, you can upgrade to DocsPage by providing a custom docs.extractComponentDescription parameter. There are different ways to use each addon, so you can adapt this recipe according to your use case.

Suppose you've added a notes parameter to each component in your library, containing markdown text, and you want that to show up at the top of the page in the Description slot. You could do that by adding the following snippet to .storybook/preview.js:

import { addParameters } from '@storybook/preview-api';

addParameters({
  docs: {
    extractComponentDescription: (component, { notes }) => {
      if (notes) {
        return typeof notes === 'string' ? notes : notes.markdown || notes.text;
      }
      return null;
    },
  },
});

The default extractComponentDescription provided by the docs preset extracts JSDoc code comments from the component source, and ignores the second argument, which is the story parameters of the currently-selected story. In contrast, the code snippet above ignores the comment and uses the notes parameter for that story.

Exporting documentation

⚠️ The --docs flag is an experimental feature in Storybook 5.2. The behavior may change in 5.3 outside of the normal semver rules. Be forewarned!

The Storybook UI is a workshop for developing components in isolation. Storybook Docs is a showcase for documenting your components. During component/docs development, it’s useful to see both of these modes side by side. But when you export your static storybook, you might want to export the docs to reduce clutter.

To address this, we’ve added a CLI flag to only export the docs. This flag is also available in dev mode:

yarn build-storybook --docs

Disabling docs stories

There are two cases where a user might wish to exclude stories from their documentation pages:

DocsPage

User defines stories in CSF and renders docs using DocsPage, but wishes to exclude some fo the stories from the DocsPage to reduce noise on the page.

export const foo = () => <Button>foo</Button>;
foo.parameters = { docs: { disable: true } };

MDX Stories

User writes documentation & stories side-by-side in a single MDX file, and wants those stories to show up in the canvas but not in the docs themselves. They want something similar to the recipe "CSF stories with MDX docs" but want to do everything in MDX:

<Story name="foo" parameters={{ docs: { disable: true } }}>
  <Button>foo</Button>
</Story>

Controlling a story's view mode

Storybook's default story navigation behavior is to preserve the existing view mode. In other words, if a user is viewing a story in "docs" mode, and clicks on another story, they will navigate to the other story in "docs" mode. If they are viewing a story in "story" mode (i.e. "canvas" in the UI) they will navigate to another story in "story" mode (with the exception of "docs-only" pages, which are always shown in "docs" mode).

Based on user feedback, it's also possible to control the view mode for an individual story using the viewMode story parameter. In the following example, the nav link will always set the view mode to story:

export const Foo = () => <Component />;
Foo.parameters = {
  // reset the view mode to "story" whenever the user navigates to this story
  viewMode: 'story',
};

This can also be applied globally in .storybook/preview.js:

// always reset the view mode to "docs" whenever the user navigates
export const parameters = {
  viewMode: 'docs',
};

Reordering Docs tab first

You can configure Storybook's preview tabs with the previewTabs story parameter.

Here's how to show the Docs tab first for a story (or globally in .storybook/preview.js):

export const Foo = () => <Component />;
Foo.parameters = {
  previewTabs: { 'storybook/docs/panel': { index: -1 } },
};

Customizing source snippets

As of SB 6.0, there are two ways to customize how Docs renders source code, via story parameter or via a formatting function.

If you override the docs.source.code parameter, the Source block will render whatever string is added:

const Example = () => <Button />;
Example.parameters = {
  docs: { source: { code: 'some arbitrary string' } },
};

Alternatively, you can provide a function in the docs.transformSource parameter. For example, the following snippet in .storybook/preview.js globally removes the arrow at the beginning of a function that returns a string:

const SOURCE_REGEX = /^\(\) => `(.*)`$/;
export const parameters = {
  docs: {
    transformSource: (src, storyContext) => {
      const match = SOURCE_REGEX.exec(src);
      return match ? match[1] : src;
    },
  },
};

These two methods are complementary. The former is useful for story-specific, and the latter is useful for global formatting.

Overwriting docs container

What happens if you want to add some wrapper for your MDX page, or add some other kind of React context?

When you're writing stories you can do this by adding a decorator, but when you're adding arbitrary JSX to your MDX documentation outside of a <Story> block, decorators no longer apply, and you need to use the docs.container parameter.

The closest Docs equivalent of a decorator is the container, a wrapper element that is rendered around the page that is being rendered. Here's an example of adding a solid red border around the page. It uses Storybook's default page container (that sets up various contexts and other magic) and then inserts its own logic between that container and the contents of the page:

import { Meta, DocsContainer } from '@storybook/addon-docs';

<Meta
  title="Addons/Docs/container-override"
  parameters={{
    docs: {
      container: ({ children, context }) => (
        <DocsContainer context={context}>
          <div style={{ border: '5px solid red' }}>{children}</div>
        </DocsContainer>
      ),
    },
  }}
/>

# Title

Rest of your file...

This is especially useful if you are using styled-components and need to wrap your JSX with a ThemeProvider to have access to your theme:

import { Meta, DocsContainer } from '@storybook/addon-docs';
import { ThemeProvider } from 'styled-components'
import { theme } from '../path/to/theme'

<Meta
  title="Addons/Docs/container-override"
  parameters={{
    docs: {
      container: ({ children, context }) => (
        <DocsContainer context={context}>
          <ThemeProvider theme={theme}>
            {children}
          </ThemeProvider>
        </DocsContainer>
      ),
    },
  }}
/>

# Title

Rest of your file...

Add description to individual stories

Add story to docs.description parameter

const Example = () => <Button />;

Example.parameters = {
  docs: {
    description: {
      story: 'Individual story description, may contain `markdown` markup',
    },
  },
};

There is also an webpack loader package that extracts descriptions from jsdoc comments story-description-loader

More resources