Icon Button

An interactive component that packages an icon inside a click target for compact layouts.

Usage

Disabled

Use the disabled class to disable the component.

Sizes

Use the icon-button-{size} class to control the component size.

Size values can include:smmdlgxl.

For more information on all available sizing utilities, visit Tailwind

Variants

Use the variant and palette classes to control the appereance of the component.

Variant values can include solidoutlinesurfacesubtleghostlinkplain.
Color palettes can include primaryneutral. For extra palettes such as warning error and more, refer to the Colors section.

Customizing

globals.css


:root {
  --ex-icon-button-cursor: pointer;
 
  --ex-icon-button-font-size-sm: var(--text-base);
  --ex-icon-button-font-size-md: var(--text-lg);
  --ex-icon-button-font-size-lg: var(--text-xl);
  --ex-icon-button-font-size-xl: var(--text-2xl);
 
  --ex-icon-button-size-sm: calc(var(--spacing) * 9);
  --ex-icon-button-size-md: calc(var(--spacing) * 10);
  --ex-icon-button-size-lg: calc(var(--spacing) * 11);
  --ex-icon-button-size-xl: calc(var(--spacing) * 12);
 
  --ex-icon-button-radius-sm: var(--radius-sm);
  --ex-icon-button-radius-md: var(--radius-sm);
  --ex-icon-button-radius-lg: var(--radius-sm);
  --ex-icon-button-radius-xl: var(--radius-sm);
}

API

Element	Selector
`IconButton`	`.ex-icon-button`

Prop	Type	Default
`as`	`ElementType`	`button`
`asChild`	`boolean`	`false`