Checkbox Group
Groups related checkboxes with shared labeling and validation.
Installation
Install Checkbox Group from Oros with shadcn CLI 4.13.0.
pnpm dlx shadcn@4.13.0 add @oros/checkbox-groupUsage
import {
CheckboxGroup,
CheckboxGroupPrimitive,
} from "@/components/ui/checkbox-group"Open the Source tab in the preview for a complete working example.
Anatomy
| Export | Responsibility |
|---|---|
| CheckboxGroup | Groups related items into one logical set. |
| CheckboxGroupPrimitive | A composable part of the component anatomy. |
API Reference
Checkbox Group exports 2 named entries. Component exports accept the props of their underlying HTML element or Base UI component, plus an optional className, unless the source defines a more focused type.
CheckboxGroupComponentCheckboxGroupPrimitiveComponent
Accessibility
- Provide Checkbox Group with a visible label or an equivalent programmatic accessible name.
- Expose disabled, required, selected, and invalid states through the component API instead of color alone, and keep keyboard focus visible.
Source
Checkbox Group is maintained by Oros and follows the same conventions as the rest of the library. Installing it adds the component source and required dependencies to your app. The Source tab above shows a complete usage example.