Checkbox Group
A collection of checkboxes that enables users to select multiple options from a predefined list. It allows for flexible multi-selection in forms and interfaces.
Basic
A group of checkboxes that lets you select multiple options at once.
Installation
npx shadcn@latest add @intentui/checkboxComposed components
When you install this component via the CLI, it automatically loads all composed components, so you don’t need to add them individually.
This component comes packed with several components to enhance functionality and provide a seamless experience.
Manual installation
npm i react-aria-components @heroicons/reactAnatomy
import { Checkbox, CheckboxGroup } from "@/components/ui/checkbox"
import { Description, Label } from "@/components/ui/field"<CheckboxGroup defaultValue={["delete"]}>
<Label>User Permissions</Label>
<Description>
Select the permissions you want to grant to the user.
</Description>
<Checkbox value="read">
<Label>Read</Label>
<Description>
Can view content but cannot make changes.
</Description>
</Checkbox>
<Checkbox value="write">
<Label>Write</Label>
<Description>
Can create and modify existing content.
</Description>
</Checkbox>
<Checkbox value="delete">
<Label>Delete</Label>
<Description>Can permanently remove content.</Description>
</Checkbox>
<Checkbox value="admin">
<Label>Admin</Label>
<Description>
Full access to all actions and settings.
</Description>
</Checkbox>
</CheckboxGroup>Description
Add a description to the checkbox group using the description prop.
Validation
The checkbox group is in an error state.
Indeterminate
The checkbox group is in an indeterminate state.
Controlled
Control the checkbox group value with the value prop.
Uncontrolled
Control the checkbox group value with the defaultValue prop.
Disabled
Disable the entire checkbox group by passing the isDisabled prop.
Read only
When you need just a read-only checkbox group, pass the isReadOnly prop.
<CheckboxGroup isReadOnly/>