mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-08 02:31:49 +08:00
34 lines
1.0 KiB
Markdown
34 lines
1.0 KiB
Markdown
---
|
|
title: 'Title'
|
|
---
|
|
|
|
<YouTubeCallout id="uAA1JvLcl-w" title="Avoid Documentation Nightmares with Storybook's Title Doc Block" params='start=57' />
|
|
|
|
The `Title` block serves as the primary heading for your docs entry. It is typically used to provide the component or page name.
|
|
|
|
|
|
|
|
<!-- prettier-ignore-start -->
|
|
```md
|
|
{/* ButtonDocs.mdx */}
|
|
|
|
import { Title } from '@storybook/blocks';
|
|
|
|
<Title>This is the title</Title>
|
|
```
|
|
<!-- prettier-ignore-end -->
|
|
|
|
## Title
|
|
|
|
```js
|
|
import { Title } from '@storybook/blocks';
|
|
```
|
|
|
|
`Title` is configured with the following props:
|
|
|
|
### `children`
|
|
|
|
Type: `JSX.Element | string`
|
|
|
|
Provides the content. Falls back to value of `title` in an [attached](./doc-block-meta.md#attached-vs-unattached) CSF file (or value derived from [autotitle](../configure/sidebar-and-urls.md#csf-30-auto-titles)), trimmed to the last segment. For example, if the title value is `'path/to/components/Button'`, the default content is `'Button'`.
|