Preview

Import

import { CheckboxGroup, CheckboxGroupItem } from "@sigil-ui/components";

Usage

<CheckboxGroup defaultValue={["a"]} onValueChange={(value) => console.log(value)}>
  <CheckboxGroupItem value="a" label="Option A" description="Short explainer." />
  <CheckboxGroupItem value="b" label="Option B" />
</CheckboxGroup>

You can also pass an items array as a shorthand:

<CheckboxGroup
  items={[
    { value: "a", label: "Option A" },
    { value: "b", label: "Option B" },
  ]}
/>

Sub-components

This component includes the following parts:

<CheckboxGroupItem>

Props

CheckboxGroup

Prop	Type	Default	Description
`value`	`string[]`	—	Controlled selection.
`defaultValue`	`string[]`	`[]`	Uncontrolled initial selection.
`onValueChange`	`(value: string[]) => void`	—	Called with the next selection on every toggle.
`disabled`	`boolean`	`false`	Disables every item in the group.
`name`	`string`	—	Form field name applied to each underlying checkbox.
`items`	`CheckboxGroupItemConfig[]`	—	Shorthand for rendering items without children.
`orientation`	`"vertical" \| "horizontal"`	`"vertical"`	Stacks items in a column or wraps them in a row.

CheckboxGroupItem

Prop	Type	Default	Description
`value`	`string`	—	Item value used to identify the selection.
`label`	`ReactNode`	—	Primary label text.
`description`	`ReactNode`	—	Optional secondary copy displayed below the label.
`disabled`	`boolean`	`false`	Disables this individual item.

Token integration

CSS Variable	Purpose
`--s-text`	Item label color
`--s-text-muted`	Item description color
`--s-primary`	Selected checkbox fill
`--s-primary-contrast`	Checkmark color on selected state
`--s-border`	Unselected checkbox border
`--s-border-style`	Border style (solid / dashed / dotted)
`--s-radius-sm`	Checkbox corner radius
`--s-focus-ring-color`	Focus ring color
`--s-focus-ring-width`	Focus ring width

Checkbox Group

Preview

Import

Usage

Sub-components

Props

CheckboxGroup

CheckboxGroupItem

Token integration

On this page