A next-generation tool to create blazing-fast documentation sites
API
created:4/19/2020
,
updated:1/12/2021

Starter

This example demonstrates documenting a hypothetical Button component that supports variants, icons, text, and padding

Overview

In the Playground, you can view the source code, apply zoom or background...

Name
Description
Default
Controls
text

button label of text

string
-
variant

variant kind

primaryaccentdisabledsuccesswarningerror
primary
fontSize

font size for the Button label

number
18
icon

icon kind

nonesearchleft-arrowright-arrowdown-arrowup-arrow
-
iconSide

on which side of the label should the icon be placed

leftright
left
iconSize

icon size

smallmediumlarge
small
padding

padding variants

smallmediumlarge
medium
isPrimary

boolean switch for primary variant @deprecated since version 1.0

boolean
false

A11y tests

Viewport

320px

375px

768px

1024px