@k8ordo/ui

IconButton

A button that shows only an icon. label is required, and becomes its tooltip and accessible name.

Import

ts
import { IconButton } from '@k8ordo/ui';

Usage

tsx
import { XIcon } from '@k8ordo/ui/icons';

<IconButton label="Close">
  <XIcon size="sm" />
</IconButton>

Sizes

tsx
<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

tsx
<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

tsx
<IconButton disabled label="Close">
  <XIcon size="sm" />
</IconButton>

Rendering as a link

tsx
<IconButton
  label="Close"
  renderItem={({
    children,
    disabled: _disabled,
    triggerProps,
    type: _type,
    ...props
  }) => (
    <a href="https://example.com" {...props} {...triggerProps}>
      {children}
    </a>
  )}
>
  <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'
PropTypeDefault
labelstring-
children?ReactNode-
color?'transparent'|'base'|'primary'|'secondary''transparent'
onAction?() => void | Promise<void>-
renderItem?(props: IconButtonRenderItemProps) => ReactNode-
size?'sm'|'md'|'lg''md'
tooltipDisabled?booleanfalse
tooltipPlacement?Placement'top'

Inherited attributes (except the ones set internally): ComponentPropsWithRef<'button'>

k8ordo

React libraries that use Baseline features without holding back.