mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-06 07:21:16 +08:00
45 lines
856 B
Plaintext
45 lines
856 B
Plaintext
---
|
|
title: 'Subtitle'
|
|
sidebar:
|
|
order: 13
|
|
title: Subtitle
|
|
---
|
|
|
|
<YouTubeCallout id="uAA1JvLcl-w" title="Avoid Documentation Nightmares with Storybook's Subtitle Doc Block" params="start=98" />
|
|
|
|
The `Subtitle` block can serve as a secondary heading for your docs entry.
|
|
|
|
|
|
|
|
{/* prettier-ignore-start */}
|
|
|
|
```md title="ButtonDocs.mdx"
|
|
import { Subtitle } from '@storybook/blocks';
|
|
|
|
<Subtitle>This is the subtitle</Subtitle>
|
|
```
|
|
|
|
{/* prettier-ignore-end */}
|
|
|
|
## Subtitle
|
|
|
|
```js
|
|
import { Subtitle } from '@storybook/blocks';
|
|
```
|
|
|
|
`Subtitle` is configured with the following props:
|
|
|
|
### `children`
|
|
|
|
Type: `JSX.Element | string`
|
|
|
|
Default: `parameters.docs.subtitle`
|
|
|
|
Provides the content.
|
|
|
|
### `of`
|
|
|
|
Type: CSF file exports
|
|
|
|
Specifies which meta's subtitle is displayed.
|