Augeo AI Docs
Augeo Design SystemComponents

Checkbox

A square box that turns one option on or off inside a form, with a mixed state for a parent whose children are partly on. The caller owns the checked value and the label.

Checkbox

Checkbox turns one option on or off inside a form that saves on submit, and draws a mixed state for a parent row whose children are partly on. It carries no label, so the caller names it with a label that points at its id. A setting that takes effect at once is a Switch, not a Checkbox.

Storybook

Loading

Props

Prop

Type

Also takes the attributes of the element it renders.

Tokens

Derived from the component source at docs-generation time — these are the --augds-* variables it reads. Re-theme the colour slots by constructing a partner DesignSystemTheme and wrapping the consumer subtree in <ThemeProvider>, never by hard-coding values.

  • --augds-background-brand
  • --augds-border-input
  • --augds-foreground-on-brand
  • --augds-interaction-focus-ring
  • --augds-radius-primitive-6
  • --augds-surface-raised

Source

  • src/components/ui/checkbox/checkbox.tsx