Button

Markdown

A versatile Button component for triggering actions and events.

<Flex gap="4" wrap="wrap" align="center" justify="center" className="w-full">
  <Button variant="solid">Solid Button</Button>
</Flex>

Anatomy

<Button />

Examples

Variants

Button components come with four built in variants, solid, outlined, muted, and clear.

<Flex gap="4" wrap="wrap" align="center" justify="center" className="w-full">
  {["solid", "outlined", "muted", "clear"].map((variant) => (
    <Button key={variant} variant={variant}>
      {variant.charAt(0).toUpperCase() + variant.slice(1)} Button
    </Button>
  ))}
</Flex>

Colors

The button component uses the color prop to allow for predefined and custom colors.

<Flex gap="4" wrap="wrap" align="center" justify="center" className="w-full">
  {[
    "primary",
    "secondary",
    "tertiary",
    "success",
    "danger",
    "warning",
    "info",
  ].map((color) => (
    <Button key={color} color={color} variant="muted">
      {color.charAt(0).toUpperCase() + color.slice(1)} Button
    </Button>
  ))}
</Flex>

Sizes

To manage the size of the button component you can provide a default or custom size through the size prop.

<Flex gap="4" wrap="wrap" align="center" justify="center" className="w-full">
  {["xs", "sm", "md", "lg", "xl"].map((size) => (
    <Button key={size} size={size} variant="muted">
      {size.toUpperCase()} Button
    </Button>
  ))}
</Flex>

States

Buttons can be given the disabled and readonly states.

<Flex gap="4" wrap="wrap" align="center" justify="center" className="w-full">
  <Button variant="solid">Default</Button>
  <Button variant="solid" disabled>
    Disabled
  </Button>
  <Button variant="solid" readonly>
    Readonly
  </Button>
</Flex>

Each variant has its own disabled styling.

<Flex gap="4" wrap="wrap" align="center" justify="center" className="w-full">
  {["solid", "outlined", "muted", "clear"].map((variant) => (
    <Button disabled key={variant} variant={variant}>
      {variant.charAt(0).toUpperCase() + variant.slice(1)} Disabled
    </Button>
  ))}
</Flex>

High Contrast

The highContrast prop enables high contrast mode for better visibility. High contrast button styles are only available with the solid variant.

<Flex gap="4" wrap="wrap" align="center" justify="center" className="w-full">
  <Button highContrast variant="solid">
    <span>High Contrast</span>
  </Button>
</Flex>