loc
104
comments
30%
todos
2
passed
10
coverage
69%
Starter
This example demonstrates documenting a hypothetical Button component that supports variants, icons, text, and padding
Name | Description | Default | Controls |
---|---|---|---|
text | button label of text string | - | |
variant | variant kind disabledprimaryaccentsuccesswarningerror | primary | |
fontSize | font size for the Button label number | 18 | |
icon | icon kind nonesearchleft-arrowright-arrowdown-arrowup-arrow | none | |
iconSide | on which side of the label should the icon be placed leftright | left | |
iconSize | icon size smallmediumlarge | small | |
padding | padding variants smallmediumlarge | medium |
Name | Description | Default | |
---|---|---|---|
VariantButtonProps(8 properties) | |||
text | button label of text string | - | |
variant | variant kind disabledprimaryaccentsuccesswarningerror | primary | |
fontSize | font size for the Button label number | 18 | |
icon | icon kind nonesearchleft-arrowright-arrowdown-arrowup-arrow | none | |
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 boolean | false | |
AllHTMLAttributes(106 properties) | |||
HTMLAttributes(43 properties) | |||
AriaAttributes(48 properties) | |||
DOMAttributes(161 properties) | |||
ClassAttributes(1 properties) | |||
Attributes(1 properties) |
package | imports | peer |
---|---|---|
@primer/octicons-react | SearchIconArrowUpIconArrowRightIconArrowLeftIconArrowDownIcon | |
react | ReactFC |