Optional
activeIf true
, indicates that the button is currently active with a different style.
Defaults to undefined
.
A value of true
or false
indicates that the button supports being active (i.e. pressed).
In that case the aria-pressed
attribute will be configured automatically
(see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-pressed).
Optional
buttonAdditional properties for the Button
element.
Note that the ToolButton also defines some of these props.
Optional
disabledIf true
, the button will be disabled.
Defaults to false
.
The icon displayed by the button.
NOTE: You can use raw icons here (e.g. svgs from react-icons).
The ToolButton will surround the icon with chakra's <Icon />
component.
This will apply the apply the aria-hidden
attribute, among other things.
The label for the ToolButton. This value services as the tooltip text and the aria-label.
This property is required for a11y reasons because a ToolButton usually only displays an icon.
Optional
loadingIf true
, the button will show a spinner.
Defaults to false
.
Optional
onThe callback that will be called when the user clicks the button.
Optional
tooltipAdditional properties for the Tooltip
element.
Note that the ToolButton also defines some of these props.
Properties supported by ToolButton.