Checkbox

Binary toggle controls for selecting multiple options.

When to Use

  • For selecting multiple items from a list
  • For boolean on/off toggles
  • For agree/disagree confirmations

Import

import { Checkbox } from "orizon";

Examples

Basic

<Checkbox>Remember me</Checkbox>

Group

<Checkbox.Group
  options={["Apple", "Banana", "Orange"]}
  defaultValue={["Apple"]}
  onChange={(values) => console.log(values)}
/>

Disabled

<Checkbox disabled>Disabled</Checkbox>
<Checkbox disabled checked>Disabled Checked</Checkbox>

Indeterminate

Use indeterminate state for "check all" patterns.

<Checkbox indeterminate={indeterminate} onChange={onCheckAll}>
  Check All
</Checkbox>

API

CheckboxProps

  • checkedboolean — Checked state (controlled)
  • defaultCheckedboolean — Default checked state
  • indeterminateboolean — Indeterminate (partial) state
  • onChange(e: CheckboxChangeEvent) => void — Change handler
  • disabledboolean — Disable the checkbox

Checkbox.Group Props

  • options(string | { label, value, disabled })[] — Option list
  • valuestring[] — Checked values (controlled)
  • defaultValuestring[] — Default checked values
  • onChange(checkedValues: string[]) => void — Change handler
  • disabledboolean — Disable all checkboxes