A next-generation tool to create blazing-fast documentation sites
API
created:4/29/2021
updated:4/29/2021
loc
103
comments
30%
todos
2
passed
2
coverage
83%

Starter

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

import { VariantButton } from 'component-controls-stories';

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

undefinedprimaryaccentdisabledsuccesswarningerror
primary
fontSize

font size for the Button label

number
18
icon

icon kind

undefinednonesearchleft-arrowright-arrowdown-arrowup-arrow
-
iconSide

on which side of the label should the icon be placed

undefinedleftright
left
iconSize

icon size

undefinedsmallmediumlarge
small
padding

padding variants

undefinedsmallmediumlarge
medium
isPrimary

boolean switch for primary variant

boolean
false

Commits

Date
Author
Commit Message
4/20/2021

atanasster

avatar of atanasster
docs: refactor starter story for tests
1 commits
package
imports
peer
@primer/octicons-react
SearchIconArrowUpIconArrowRightIconArrowLeftIconArrowDownIcon
react
ReactFC