storybook/docs/api/doc-block-subtitle.md
Kyle Gach fb48b37e90 Address comments
- Consistently include space after filename comment
- Include `<Meta />` in snippets for blocks that are used in attached docs
- Grammatical improvements
2023-02-21 22:38:18 -07:00

34 lines
569 B
Markdown

---
title: 'Subtitle'
---
The `Subtitle` block can serve as a secondary heading for your docs entry.
![Screenshot of Subtitle block](TK)
<!-- prettier-ignore-start -->
```md
{/* ButtonDocs.mdx */}
import { Subtitle } from '@storybook/blocks';
<Subtitle>Allows the user to start an action</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.componentSubtitle`
Provides the content.