mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-06 04:21:16 +08:00
56 lines
1.1 KiB
Plaintext
56 lines
1.1 KiB
Plaintext
---
|
|
title: 'Stories'
|
|
sidebar:
|
|
order: 11
|
|
title: Stories
|
|
---
|
|
|
|
<YouTubeCallout id="uAA1JvLcl-w" title="Avoid Documentation Nightmares with Storybook's Stories Doc Block" params="start=185" />
|
|
|
|
The `Stories` block renders the full collection of stories in a stories file.
|
|
|
|
|
|
|
|
{/* prettier-ignore-start */}
|
|
|
|
```md title="ButtonDocs.mdx"
|
|
import { Meta, Stories } from '@storybook/blocks';
|
|
import * as ButtonStories from './Button.stories';
|
|
|
|
<Meta of={ButtonStories} />
|
|
|
|
<Stories />
|
|
```
|
|
|
|
{/* prettier-ignore-end */}
|
|
|
|
## Stories
|
|
|
|
```js
|
|
import { Stories } from '@storybook/blocks';
|
|
```
|
|
|
|
`Stories` is configured with the following props:
|
|
|
|
### `includePrimary`
|
|
|
|
Type: `boolean`
|
|
|
|
Default: `true`
|
|
|
|
Determines if the collection of stories includes the primary (first) story.
|
|
|
|
<Callout variant="info" icon="💡">
|
|
|
|
If a stories file contains only one story and `includePrimary={true}`, the `Stories` block will render nothing to avoid a potentially confusing situation.
|
|
|
|
</Callout>
|
|
|
|
### `title`
|
|
|
|
Type: `string`
|
|
|
|
Default: `'Stories'`
|
|
|
|
Sets the heading content preceding the collection of stories.
|