Checkbox Group
Provides shared state to a series of checkboxes.
API reference
Checkbox Group is composed together with Checkbox. Import the components and place them together:
Anatomy
import { Checkbox } from '@base-ui-components/react/checkbox';
import { CheckboxGroup } from '@base-ui-components/react/checkbox-group';
<CheckboxGroup>
<Checkbox.Root />
</CheckboxGroup>
Prop | Type | Default | |
---|---|---|---|
allValues | string[] | undefined | |
className | string | (state) => string | undefined | |
defaultValue | string[] | undefined | |
disabled | boolean | false | |
onValueChange | (value, event) => void | undefined | |
render | | React.ReactElement | undefined | |
value | string[] | undefined |
Attribute | Description | |
---|---|---|
data-disabled | Present when the checkbox group is disabled. |