Icon Button

The Icon Button component renders a button with an icon. It supports various actions, including external links and loading states.

Usage & Examples

Default IconButton

default-iconbutton.tsx
<IconButton icon={FaPlus} ariaLabel="Add" />

Props API

42 props
Columns
Icon Button props API
Default
Description
aria-atomicbooleanNoariaIndicates whether screen readers should present all of a live region at once.
aria-busybooleanNoariaIndicates whether the button is busy, such as while loading.
aria-checkedboolean | "mixed"NoariaIndicates the current checked state when the icon button behaves like a checkable control.
aria-controlsstringNoariaIdentifies the element whose contents or presence are controlled by this button.
aria-currentboolean | "page" | "step" | "location" | "date" | "time"NoariaIndicates the current active item within a related set, when applicable.
aria-describedbystringNoariaOptional ID reference to one or more elements that describe this control.
aria-errormessagestringNoariaOptional ID reference to an error message element for this control.
aria-expandedbooleanNoariaIndicates whether the associated popup element is currently expanded.
aria-haspopupboolean | "dialog" | "grid" | "listbox" | "menu" | "tree"NoariaIndicates whether activating the control opens a popup element such as a menu or dialog.
aria-invalidbooleanNoariaIndicates whether the control is currently invalid.
aria-labelstringNoariaAccessible label for screen readers. Required for icon-only usage unless title is provided.
aria-labelledbystringNoariaOptional ID reference to one or more elements that label this control.