GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-04 19:41:06 +08:00
Code Issues Packages Projects Releases Wiki Activity
storybook/docs/writing-docs/doc-block-colorpalette.md
jonniebigodes 7d45940deb Updates per feedback.
2022-02-23 19:09:24 +00:00

1.3 KiB
Raw Blame History

title
ColorPalette

Storybook's ColorPalette Doc block allows you to document all color-related items (e.g., swatches) used throughout your project.

Storybook color palette doc block

Working with MDX

Similar to Typeset, the ColorPalette Doc Block is also typically used with MDX. It supports additional customization via options. Below are some examples and a table with all the available options.

<CodeSnippets paths={[ 'common/colorpalette-doc-block.starter-example.mdx.mdx', 'common/colopalette-doc-block.advanced-example.mdx.mdx', ]} />

Option Description
title Sets the name of the color to be displayed.
<ColorItem title='tomato' />
subtitle Provides an additional description to the color.
<ColorItem subtitle='This is a bright red color' />
colors Provides the list of colors to be displayed.
<ColorItem colors={{ White: '#FFFFFF', Concrete: '#F3F3F3' } />