Buttons
Buttons communicate an action to happen on user interaction.
| install | yarn add @clayui/button |
|---|---|
| version | 3.116.0 |
Stable3.116.0View in LexiconCHANGELOG
Button
| Property | Description |
|---|---|
alertboolean | Flag to indicate if button is used within an alert component. |
borderlessboolean | Flag to indicate if the button should be borderless. |
blockboolean | Renders the button as a block element. |
darkboolean | Flag to indicate if the button should use the clay-dark variant. |
displayType| null
| 'primary'
| 'secondary'
| 'link'
| 'success'
| 'warning'
| 'danger'
| 'info'
| 'beta'
| 'beta-dark'
| 'unstyled' | Determines the button variant to use.
The values beta and beta-dark are deprecated since v3.100.0 - use
translucent and dark instead.
The values null and unstyled are for internal use only.The default value is 'primary' |
monospacedboolean | Flag to indicate if button should be monospaced. |
outlineboolean | Flag to indicate if the button should use the outline variant. |
roundedboolean | Flag to indicate if the button should be shaped like a pill. |
size'xs' | 'regular' | 'sm' | Determines the size of a button. The default value is 'regular' |
smallboolean | Indicates button should be a small variant.
@deprecated since v3.72.0 - use size instead. |
translucentboolean | Flag to indicate if the button should use the translucent variant. |
type | The default value is 'button' |
Button.Group
| Property | Description |
|---|---|
spacedboolean | Flag to indicate the spacing between the buttons. |
verticalboolean | Flag to indicate if buttons are stacked vertically. |
role | The default value is 'group' |
ButtonWithIcon
| Property | Description |
|---|---|
spritemapstring | Path to the location of the spritemap resource. |
symbolstring | The id of the icon in the spritemap. |
monospaced | The default value is true |