IconButton composes the Button
component except that it renders only an icon.
Since IconButton
only renders an icon, you must pass the aria-label
prop, so
screen readers can give meaning to the button.
The IconButton component accepts most of the props from the Button
component,
so we can use colorScheme
prop to change the color of the button.
Like the Button component, pass the size
prop to change the size of the
button.
Like the Button component, pass the variant
prop to change the style of the
button.
You can also use icons from popular libraries like react-icons and just pass it into the button.
Name | Type | Default | Description |
---|---|---|---|
size | sm , md , lg | md | Specifies an explicit icon size instead of the default value. |
icon | string | null | The icon to be used. Refer to the Icons section of the docs for the available icon options. |
isRound | boolean | false | If true , the button will be perfectly round. Else, it'll be slightly round. |
aria-label (required) | string | A11y: A label that describes the button. | |
variant | outline , ghost , unstyled , link , solid | solid | The variant of the button style to use. |
colorScheme | string | gray | The color scheme of the button. |
isDisabled | boolean | If true , the button will be disabled. | |
isLoading | boolean | If true , the button will show a spinner. |