storybook/docs/api/doc-blocks/doc-block-icongallery.mdx
Kyle Gach 35d30d2914 Fix links that were missing new directories
e.g. `./api/main-config-typescript.mdx` -> `./api/main-config/main-config-typescript.mdx`
2024-06-27 22:25:03 -06:00

98 lines
1.9 KiB
Plaintext

---
title: 'IconGallery'
sidebar:
order: 6
title: IconGallery
---
<YouTubeCallout id="tyNIspWhFyU" title="Storybook for Design Systems - IconGallery Doc Block" params="start=131" />
The `IconGallery` block enables you to easily document React icon components associated with your project, displayed in a neat grid.
![Screenshot of IconGallery and IconItem blocks](../../_assets/doc-block-icongallery.png)
{/* prettier-ignore-start */}
```md
{/* Iconography.mdx */}
import { Meta, Title, IconGallery, IconItem } from '@storybook/blocks';
import { Icon as IconExample } from './Icon';
<Meta title="Iconography" />
# Iconography
<IconGallery>
<IconItem name="mobile">
<IconExample name="mobile" />
</IconItem>
<IconItem name="user">
<IconExample name="user" />
</IconItem>
<IconItem name="browser">
<IconExample name="browser" />
</IconItem>
<IconItem name="component">
<IconExample name="component" />
</IconItem>
<IconItem name="calendar">
<IconExample name="calendar" />
</IconItem>
<IconItem name="paintbrush">
<IconExample name="paintbrush" />
</IconItem>
<IconItem name="add">
<IconExample name="add" />
</IconItem>
<IconItem name="subtract">
<IconExample name="subtract" />
</IconItem>
<IconItem name="document">
<IconExample name="document" />
</IconItem>
<IconItem name="graphline">
<IconExample name="graphline" />
</IconItem>
</IconGallery>
```
{/* prettier-ignore-end */}
## IconGallery
```js
import { IconGallery } from '@storybook/blocks';
```
`IconGallery` is configured with the following props:
### `children`
Type: `React.ReactNode`
`IconGallery` expects only `IconItem` children.
## IconItem
```js
import { IconItem } from '@storybook/blocks';
```
`IconItem` is configured with the following props:
### `name`
(**Required**)
Type: `string`
Sets the name of the icon.
### `children`
Type: `React.ReactNode`
Provides the icon to be displayed.