storybook/docs/api/doc-block-primary.md
2023-08-15 13:47:19 -07:00

1003 B
Raw Blame History

title
Primary

The Primary block displays the primary (first defined in the stories file) story, in a Story block. It is typically rendered immediately under the title in a docs entry.

Screenshot of Primary block

{/* ButtonDocs.mdx */}

import { Meta, Primary } from '@storybook/blocks';
import * as ButtonStories from './Button.stories';

<Meta of={ButtonStories} />

<Primary />

Primary

import { Primary } from '@storybook/blocks';

Primary is configured with the following props:

of

Type: CSF file exports

Specifies the primary (first) story to be rendered.

name

( Deprecated)

Type: string

Primary block should only be used to render the primary story, which is automatically found.