Basic Components

IconButton

A square icon-only button with customizable appearance, size, and shape. Supports loading state and renders as anchor when href is provided.

Basic Usage

A square button designed for icon-only actions. Always provide aria-label for accessibility.

<IconButton aria-label="Search"><SearchIcon /></IconButton>
<IconButton aria-label="Settings"><SettingsIcon /></IconButton>
<IconButton aria-label="Delete"><TrashIcon /></IconButton>

Sizes

IconButton supports five sizes: xs, sm, md (default), lg, xl.

Sizes.tsx

<Row flexWrap itemsEnd>
  <Col itemsCenter>
    <IconButton aria-label="Star xs" xs>
      <Star />
    </IconButton>
    <Text secondary sm>xs</Text>
  </Col>
  <Col itemsCenter>
    <IconButton aria-label="Star sm" sm>
      <Star />
    </IconButton>
    <Text secondary sm>sm</Text>
  </Col>
  <Col itemsCenter>
    <IconButton aria-label="Star md" md>
      <Star />
    </IconButton>
    <Text secondary sm>md</Text>
  </Col>
  <Col itemsCenter>
    <IconButton aria-label="Star lg" lg>
      <Star />
    </IconButton>
    <Text secondary sm>lg</Text>
  </Col>
  <Col itemsCenter>
    <IconButton aria-label="Star xl" xl>
      <Star />
    </IconButton>
    <Text secondary sm>xl</Text>
  </Col>
</Row>

Appearances & Variants

Combine appearance and variant props for different styles.

Appearances&Variants.tsx

<Col>
  <Row flexWrap>
    <IconButton aria-label="Primary">
      <Star />
    </IconButton>
    <IconButton aria-label="Secondary" secondary>
      <Heart />
    </IconButton>
    <IconButton aria-label="Success" success>
      <Star />
    </IconButton>
    <IconButton aria-label="Danger" danger>
      <Trash2 />
    </IconButton>
    <IconButton aria-label="Warning" warning>
      <Star />
    </IconButton>
    <IconButton aria-label="Info" info>
      <Star />
    </IconButton>
  </Row>
  <Row flexWrap>
    <IconButton aria-label="Primary filled" filled>
      <Star />
    </IconButton>
    <IconButton aria-label="Secondary filled" filled secondary>
      <Heart />
    </IconButton>
    <IconButton aria-label="Success filled" filled success>
      <Star />
    </IconButton>
    <IconButton aria-label="Danger filled" danger filled>
      <Trash2 />
    </IconButton>
    <IconButton aria-label="Warning filled" filled warning>
      <Star />
    </IconButton>
    <IconButton aria-label="Info filled" filled info>
      <Star />
    </IconButton>
  </Row>
</Col>

Shapes

IconButton supports rounded (default), pill, and sharp shapes.

pill

sharp

rounded

Shapes.tsx

<Row flexWrap>
  <Col itemsCenter>
    <IconButton aria-label="Star pill" filled pill>
      <Star />
    </IconButton>
    <Text secondary sm>pill</Text>
  </Col>
  <Col itemsCenter>
    <IconButton aria-label="Star sharp" filled sharp>
      <Star />
    </IconButton>
    <Text secondary sm>sharp</Text>
  </Col>
  <Col itemsCenter>
    <IconButton aria-label="Star rounded" filled rounded>
      <Star />
    </IconButton>
    <Text secondary sm>rounded</Text>
  </Col>
</Row>

Loading State

Set loading to show a spinner and auto-disable the button.

const [loading, setLoading] = useState(false);

<IconButton loading={loading} onClick={() => setLoading(true)} aria-label="Save">
  <StarIcon />
</IconButton>

Click to trigger loading state

As Link

Pass href to render as an anchor tag.

AsLink.tsx

<Row>
  <IconButton aria-label="GitHub" href="https://github.com" target="_blank">
    <ExternalLink />
  </IconButton>
  <IconButton
    aria-label="GitHub secondary"
    href="https://github.com"
    secondary
    target="_blank"
  >
    <ExternalLink />
  </IconButton>
</Row>

IconButton Props

Size

Size props for controlling component dimensions

Extra small size

Small size

Medium size (default)

Large size

Extra large size

Hide

Hide props for responsive element visibility

mobileHide

Hide element on mobile devices and below (max-mobile: 48rem)

tabletHide

Hide element on tablet devices and below (max-tablet: 64rem)

desktopHide

Hide element on desktop devices and below (max-desktop: 80rem)

Items

Items props for controlling flex item alignment (align-items)

itemsStart

Align items to start (top/left)

itemsEnd

Align items to end (bottom/right)

itemsCenter

Align items to center

itemsBaseline

Align items to baseline

itemsStretch

Stretch items to fill container

Justify

Justify props for controlling flex content alignment (justify-content)

justifyStart

Pack items toward the start of the main axis

justifyEnd

Pack items toward the end of the main axis

justifyCenter

Center items along the main axis

justifyBetween

Distribute items with space between them

justifyAround

Distribute items with space around them

justifyEvenly

Distribute items with equal space around them

justifyStretch

Stretch items to fill the main axis

justifyBaseline

Align items along their baseline on main axis

Position

Position props for controlling CSS position property

relative

Relative positioning

absolute

Absolute positioning

fixed

Fixed positioning

sticky

Sticky positioning

static

Static positioning

Display

Display props for controlling CSS display property

inline

Inline display - flows with text

block

Block display - takes full width, new line

inlineBlock

Inline-block display - inline but with block properties

flex

Flex display - flexbox container

inlineFlex

Inline-flex display - inline flexbox container

grid

Grid display - CSS grid container

inlineGrid

Inline-grid display - inline grid container

contents

Contents display - element's box is removed, children display as if parent didn't exist

table

Table display - behaves like table element

tableCell

Table-cell display - behaves like td element

hidden

Hidden display - element is not visible

Overflow

Overflow props for controlling content overflow behavior

overflowAuto

Auto overflow - show scrollbars if needed

overflowHidden

Hidden overflow - clip content without scrollbars

overflowClip

Clip overflow - hard clip without scrollbars

overflowVisible

Visible overflow - content extends beyond bounds

overflowScroll

Scroll overflow - always show scrollbars

overflowXAuto

Auto overflow on X-axis only

overflowYAuto

Auto overflow on Y-axis only

overflowXHidden

Hidden overflow on X-axis only

overflowYHidden

Hidden overflow on Y-axis only

overflowXClip

Clip overflow on X-axis only

overflowYClip

Clip overflow on Y-axis only

overflowXVisible

Visible overflow on X-axis only

overflowYVisible

Visible overflow on Y-axis only

overflowXScroll

Scroll overflow on X-axis only

overflowYScroll

Scroll overflow on Y-axis only

Wrap

Wrap props for controlling flex wrapping behavior

flexWrap

Allow flex items to wrap to new lines when container is too narrow

flexNoWrap

Force flex items to stay on single line (may overflow)

flexWrapReverse

Wrap flex items in reverse order (last items wrap first)

Gap

Gap props for controlling spacing between children

gap

Enable gap spacing between children

noGap

Disable gap spacing

Flex Direction

Flex direction props for controlling flex layout direction

row

Flex direction row (horizontal)

column

Flex direction column (vertical)

rowReverse

Flex direction row-reverse

columnReverse

Flex direction column-reverse

Reverse

Reverse props for reversing child order

reverse

Reverse the order of children

Appearance

Appearance props for controlling component colors

primary

Primary color appearance (gray)

brand

Brand color appearance (blue)

accent

Accent color appearance (rose)

secondary

Secondary color appearance (gray)

tertiary

Tertiary color appearance

success

Success color appearance (green)

danger

Danger color appearance (red)

warning

Warning color appearance (amber)

info

Info color appearance (cyan)

link

Link color appearance (blue, for hyperlinks)

inherit

Inherit appearance from parent — suppresses own data-appearance/data-variant, uses parent's CSS variables

Border

Border props for controlling component borders

border

Enable border on all sides

borderT

Enable border on top

borderB

Enable border on bottom

borderL

Enable border on left

borderR

Enable border on right

borderX

Enable border on left and right

borderY

Enable border on top and bottom

noBorder

Disable all borders

Shadow

Shadow props for controlling drop shadows

shadow

Enable drop shadow

noShadow

Disable drop shadow

Ring

Ring props for controlling focus rings

ring

Enable focus ring

noRing

Disable focus ring

Focus Visible

Focus visible props for controlling focus-visible outlines

focusVisible

Enable focus-visible outline

noFocusVisible

Disable focus-visible outline

Shape

Shape props for controlling component border radius

pill

Fully rounded corners (circular)

sharp

No rounded corners (square)

rounded

Medium rounded corners (default)

Font Weight

Font weight props for controlling text weight

thin

Thin font weight (100)

extralight

Extra light font weight (200)

light

Light font weight (300)

normal

Normal font weight (400)

medium

Medium font weight (500)

semibold

Semibold font weight (600)

bold

Bold font weight (700)

extrabold

Extra bold font weight (800)

black

Black font weight (900)

Font Style

Font style props for controlling text style

italic

Italic font style

notItalic

Not italic (normal) font style

Text Decoration

Text decoration props for controlling text underline/strikethrough

underline

Add underline decoration below text

lineThrough

Add strikethrough/line-through decoration across text

noUnderline

Remove text decoration (no underline, strikethrough, etc.)

overline

Add overline decoration above text

Text Transform

Text transform props for controlling text case

uppercase

Transform text to uppercase

lowercase

Transform text to lowercase

capitalize

Capitalize first letter of each word

normalCase

Normal text case (no transformation)

Font Family

Font family props for controlling text font

sans

Sans-serif font family (default)

serif

Serif font family

mono

Monospace font family

heading

Heading font family (defaults to sans, independently customizable via --font-heading CSS variable)

Text Align

Text alignment props for controlling text position

textLeft

Align text to left

textCenter

Align text to center

textRight

Align text to right

textJustify

Justify text

Padding

Padding props for controlling internal spacing

padding

Enable internal padding

paddingX

Enable only horizontal padding

paddingY

Enable only vertical padding

noPadding

Disable internal padding

Variant

Variant props for controlling component style variations

filled

Filled variant - solid background with contrasting text color

outline

Outline variant - transparent background with border and colored text (default)

Cursor

Cursor props for controlling cursor appearance

cursorPointer

Pointer cursor - indicates clickable element

cursorDefault

Default cursor - standard arrow

cursorNotAllowed

Not-allowed cursor - indicates disabled state

cursorNone

No cursor - hides the cursor

cursorText

Text cursor - indicates selectable text

cursorMove

Move cursor - indicates draggable element

cursorWait

Wait cursor - indicates loading/processing

Transition

Transition props for controlling animation effects

transition

Enable smooth transitions between states

noTransition

Disable transitions for instant state changes

Whitespace

Whitespace props for controlling text wrapping behavior

whitespaceNowrap

No wrap - text stays on single line

whitespaceNormal

Normal wrapping - default browser behavior

whitespacePre

Preserve whitespace and line breaks

whitespacePreWrap

Preserve whitespace, wrap text

whitespacePreLine

Preserve line breaks, collapse spaces, wrap text

whitespaceBreakSpaces

Break words to prevent overflow

Width

Width props for controlling component width

wFull

Set width to 100%

wFit

Set width to fit-content

wAuto

Set width to auto

wScreen

Set width to 100vw (viewport width), removes max-width constraint

Height

Height props for controlling component height

hFit

Set height to fit-content

hFull

Set height to 100%

hAuto

Set height to auto

hScreen

Set height to 100vh (viewport height), removes max-height constraint

Transparent

Transparent prop for disabling background color

transparent

Disable background color - makes component background transparent

Responsive

Responsive prop for enabling breakpoint-specific sizing

responsive

Enable responsive sizing - uses breakpoint-specific classes for font size, padding, and gap

Disabled

Disabled state for interactive components. Applies reduced opacity, not-allowed cursor, and disables pointer events.

disabled

Disable the component — reduces opacity, changes cursor to not-allowed, and prevents interaction

Controlled themes:

appearance