IconButton
A button that shows only an icon. label is required, and becomes its tooltip and accessible name.
Import
Copy code
import { IconButton } from '@k8ordo/ui';Usage
Close
Copy code
import { XIcon } from '@k8ordo/ui/icons';
<IconButton label="Close">
<XIcon size="sm" />
</IconButton>Sizes
Close
Close
Close
Copy code
<IconButton label="Close" size="sm">
<XIcon size="sm" />
</IconButton>
<IconButton label="Close" size="md">
<XIcon size="sm" />
</IconButton>
<IconButton label="Close" size="lg">
<XIcon size="sm" />
</IconButton>Colors
Close
Close
Close
Close
Copy code
<IconButton color="transparent" label="Close">
<XIcon size="sm" />
</IconButton>
<IconButton color="base" label="Close">
<XIcon size="sm" />
</IconButton>
<IconButton color="primary" label="Close">
<XIcon size="sm" />
</IconButton>
<IconButton color="secondary" label="Close">
<XIcon size="sm" />
</IconButton>Disabled
Close
Copy code
<IconButton disabled label="Close">
<XIcon size="sm" />
</IconButton>Props
label- Type:
string - Default: -
children?- Type:
ReactNode - Default: -
color?- Type:
'transparent'|'base'|'primary'|'secondary' - Default:
'transparent' onAction?- Type:
() => void | Promise<void> - Default: -
renderItem?- Type:
(props: IconButtonRenderItemProps) => ReactNode - Default: -
size?- Type:
'sm'|'md'|'lg' - Default:
'md' tooltipDisabled?- Type:
boolean - Default:
false tooltipPlacement?- Type:
Placement - Default:
'top'
| Prop | Type | Default |
|---|---|---|
label | string | - |
children? | ReactNode | - |
color? | 'transparent'|'base'|'primary'|'secondary' | 'transparent' |
onAction? | () => void | Promise<void> | - |
renderItem? | (props: IconButtonRenderItemProps) => ReactNode | - |
size? | 'sm'|'md'|'lg' | 'md' |
tooltipDisabled? | boolean | false |
tooltipPlacement? | Placement | 'top' |
Inherited attributes (except the ones set internally): ComponentPropsWithRef<'button'>