diff --git a/packages/components/src/button/README.md b/packages/components/src/button/README.md index 7f78cb981c7dc6..1bd9d997f481fb 100644 --- a/packages/components/src/button/README.md +++ b/packages/components/src/button/README.md @@ -1,8 +1,43 @@ -This component is used to implement dang sweet buttons. +# Button -#### Props +Buttons express what action will occur when the user clicks or taps it. Buttons are used to trigger an action, and they can be used for any type of action, including navigation. -The following props are used to control the display of the component. Any additional props will be passed to the rendered `` or ` + ); +} +``` + +## Props + +Name | Type | Default | Description +--- | --- | --- | --- +`href` | `string` | `undefined` | If provided, renders `a` instead of `button`. +`isDefault` | `bool` | `false` | Renders a default button style. +`isPrimary` | `bool` | `false` | Renders a primary button style. +`isLarge` | `bool` | `false` | Increases the size of the button. +`isSmall` | `bool` | `false` | Decreases the size of the button. +`isToggled` | `bool` | `false` | Renders a toggled button style. +`isBusy` | `bool` | `false` | Indicates activity while a action is being performed. +`isLink` | `bool` | `false` | Renders a button with an anchor style. +`focus` | `bool` | `false` | Whether the button is focused. + +## Related components + +* To group buttons together, use the `ButtonGroup` component. +* To display an icon inside the button, use the `IconButton` component.