Skip to content

doc-block-typeset.md

Latest commit

聽

History

History
28 lines (20 loc) 路 1.22 KB

doc-block-typeset.md

File metadata and controls

28 lines (20 loc) 路 1.22 KB
Raw
title Typeset

Storybook's Typeset Doc Block helps document the fonts used throughout your project.

Docs blocks with typography

Working with MDX

Similar to other documentation related Doc Blocks (e.g., ColorPalette, IconGallery), the TypeSet Doc Block is also commonly used with MDX. It allows additional customization via options. Below is a condensed example and table featuring all the available options.

<CodeSnippets paths={[ 'common/typeset-doc.block.mdx.mdx', ]} />

Option Description
fontFamily Provides a font family to be displayed .
<Typeset fontFamily={"Nunito Sans"} />
fontSizes Provides a list of available font sizes.
<Typeset fontSizes={[ 12, 14, 20 ]} />
fontWeight Defines the weight of the font to be displayed.
<Typeset fontWeight={800} />
sampleText Defines the text to be displayed.
<Typeset sampleText='Example Text' />