A next-generation tool to create blazing-fast documentation sites
API
created:3/12/2021
updated:3/12/2021
source lines:103
comments %:30
todo lines:2

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
3/21/2021

atanasster

docs: fix component padding required
3/11/2021

martin-stoyanov

feat: extract ComponentStats into its own component and create story
2/17/2021

atanasster

feat: components history and catalog
1/6/2021

atanasster

docs: update variant button
1/6/2021

atanasster

docs: update stories for design page
5 commits

package
imports
peer
SearchIconArrowUpIconArrowRightIconArrowLeftIconArrowDownIcon
ReactFC