Introduction

A clickable component for triggering actions and user interactions. Includes variants for icons and grouped buttons.

Usage

Basic Button

import { Button } from "../components/ui";

export default function MyPage() {
  return (
    <Button variant="solid" colorPalette="blue">
      Click me
    </Button>
  );
}

Loading state

import { Button } from "../components/ui";

export default function MyPage() {
  return (
    <Button loading loadingText="Saving...">
      Save
    </Button>
  );
}

IconButton

A button optimised for icons.

import { IconButton } from "../components/ui";
import { SearchIcon } from "./icons";

export default function MyPage() {
  return (
    <IconButton aria-label="Search">
      <SearchIcon />
    </IconButton>
  );
}

CloseButton

A pre-styled button for closing elements.

import { CloseButton } from "../components/ui";

export default function MyPage() {
  return <CloseButton onClick={() => console.log("closed")} interactive />;
}

ButtonGroup

import { Button, ButtonGroup } from "../components/ui";

export default function MyPage() {
  return (
    <ButtonGroup attached>
      <Button>First</Button>
      <Button>Second</Button>
    </ButtonGroup>
  );
}

CMS Page Builder

This component is available as a button block in the Page Builder (content/pages/*.json):

{
  "type": "button",
  "text": "Click me",
  "variant": "solid",
  "colorPalette": "blue"
}

Props

Button

Prop	Type	Description
children	any	Content to be rendered inside the component.
class	string	Custom CSS classes.

| variant | `"solid" \ | "surface" \ | "subtle" \ | "outline" \ | "plain"` | The visual style of the button. |

| size | `"2xs" \ | "xs" \ | "sm" \ | "md" \ | "lg" \ | "xl" \ | "2xl"` | The size of the button. |

| loading | boolean | If true, the button will show a loading spinner. | | loadingText | string | The text to show while loading. |

| type | `"button" \ | "submit" \ | "reset"` | The HTML button type. |

| colorPalette | string | The color theme of the button. | | interactive | boolean | Whether to enable client-side hydration. |

ButtonGroup

Prop	Type	Description
children	any	Buttons to be grouped.
attached	boolean	Whether to attach the buttons together.