mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-04 18:11:07 +08:00
26 lines
923 B
Markdown
26 lines
923 B
Markdown
---
|
|
title: 'IconGallery'
|
|
---
|
|
|
|
Storybook's `IconGallery` Doc Block enables you easily document all icons associated with your project.
|
|
|
|
|
|
|
|
## Working with MDX
|
|
|
|
Similar to other documentation-oriented Doc Blocks such as [`TypeSet`](./doc-block-typeset.md), or [`ColorPalette`](./doc-block-colorpalette.md), the `IconGallery` is also typically used with MDX. It allows you to provide additional customization via options. Below is a condensed example and table featuring all the available options.
|
|
|
|
<!-- prettier-ignore-start -->
|
|
|
|
<CodeSnippets
|
|
paths={[
|
|
'common/icongallery-doc-block.mdx.mdx',
|
|
]}
|
|
/>
|
|
|
|
<!-- prettier-ignore-end -->
|
|
|
|
| Option | Description |
|
|
| ------ | --------------------------------------------------------- |
|
|
| `name` | Sets the name of the icon. <br/> `<IconItem name="add"/>` |
|