import { StoryWithControls } from '../../../src/components/StorybookWrapper';

Checkbox

Checkbox component that supports both regular and indeterminate states, built on top of Ant Design v5 Checkbox.

Live Example

Try It

Edit the code below to experiment with the component:

tsx

function Demo() {
  return (
    <Checkbox
      // Add props here
    />
  );
}

All Checkbox States

tsx

function AllStates() {
  return (
    <div style={{ display: 'flex', flexDirection: 'column', gap: 12 }}>
      <Checkbox checked={false}>Unchecked</Checkbox>
      <Checkbox checked={true}>Checked</Checkbox>
      <Checkbox indeterminate={true}>Indeterminate</Checkbox>
      <Checkbox disabled>Disabled unchecked</Checkbox>
      <Checkbox disabled checked>Disabled checked</Checkbox>
    </div>
  );
}

Select All Pattern

tsx

function SelectAllDemo() {
  const [selected, setSelected] = React.useState([]);
  const options = ['Option A', 'Option B', 'Option C'];

  const allSelected = selected.length === options.length;
  const indeterminate = selected.length > 0 && !allSelected;

  return (
    <div>
      <Checkbox
        checked={allSelected}
        indeterminate={indeterminate}
        onChange={(e) => setSelected(e.target.checked ? [...options] : [])}
      >
        Select All
      </Checkbox>
      <div style={{ marginLeft: 24, marginTop: 8 }}>
        {options.map(opt => (
          <div key={opt}>
            <Checkbox
              checked={selected.includes(opt)}
              onChange={() => setSelected(prev =>
                prev.includes(opt) ? prev.filter(x => x !== opt) : [...prev, opt]
              )}
            >
              {opt}
            </Checkbox>
          </div>
        ))}
      </div>
    </div>
  );
}

Props

Prop	Type	Default	Description
`checked`	`boolean`	`false`	Whether the checkbox is checked.
`indeterminate`	`boolean`	`false`	Whether the checkbox is in indeterminate state (partially selected).

Import

tsx

import { Checkbox } from '@superset/components';

:::tip[Improve this page] This documentation is auto-generated from the component's Storybook story. Help improve it by editing the story file. :::