Skip to main content

Function: CheckboxGroup()

CheckboxGroup(__namedParameters): Element

Defined in: components/CheckboxGroup/CheckboxGroup.tsx:93

A semantic checkbox group built on React Aria's CheckboxGroup.

Orchestrates a set of independently-selectable Checkbox options (multi select — the counterpart of the single-select RadioGroup). Group-level validation set via isInvalid (or React Aria's validate) propagates to every child Checkbox, which surfaces the invalid State.

Entity = Selection → reads vars.colors.input.primary.*. Validation is the invalid State, never an evaluation variant.

Parameters

ParameterType
__namedParametersCheckboxGroupProps

Returns

Element

Example

<CheckboxGroup label="Notifications" description="Pick at least one">
<Checkbox value="email">Email</Checkbox>
<Checkbox value="sms">SMS</Checkbox>
</CheckboxGroup>