---
title: Checkbox Group
subtitle: Provides shared state to a series of checkboxes.
description: A high-quality, unstyled React checkbox group component that provides a shared state for a series of checkboxes.
---
> FineSoft Components documentation. Independent Stencil port; not the official Base UI website.
>
> React API text and `@base-ui/react` examples are upstream references. FineSoft Stencil examples use `finesoft-components`. Do not treat the two packages as interchangeable.
# Checkbox Group
A high-quality, unstyled React checkbox group component that provides a shared state for a series of checkboxes.
## Demo
### Tailwind
This example shows how to implement the component using Tailwind CSS.
```tsx
/* docs-comparison.tsx */
import { StencilComparison } from 'docs/src/components/StencilComparison';
import ReactCheckboxGroup from './react-checkbox-group';
import StencilCheckboxGroup from './stencil-checkbox-group';
export default function CheckboxGroupComparison() {
return
Apples
Fuji
Gala
Granny Smith
);
}
function CheckIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
```
```tsx
/* stencil-checkbox-group.tsx */
import type * as React from 'react';
export default function StencilCheckboxGroup() {
const id = 'stencil-apples-tailwind';
return (
Apples
Fuji
Gala
Granny Smith
);
}
function CheckIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
```
### CSS Modules
This example shows how to implement the component using CSS Modules.
```css
/* index.module.css */
.CheckboxGroup {
display: flex;
flex-direction: column;
align-items: start;
gap: 0.25rem;
color: oklch(14.5% 0 0deg);
@media (prefers-color-scheme: dark) {
color: white;
}
}
.Caption {
font-size: 0.875rem;
line-height: 1.25rem;
font-weight: 700;
}
.Item {
display: flex;
align-items: center;
gap: 0.5rem;
font-size: 0.875rem;
line-height: 1.25rem;
font-weight: 400;
}
.Checkbox {
box-sizing: border-box;
display: flex;
flex-shrink: 0;
width: 1rem;
height: 1rem;
align-items: center;
justify-content: center;
border: 1px solid oklch(14.5% 0 0deg);
border-radius: 0;
background-color: white;
color: white;
padding: 0;
margin: 0;
@media (prefers-color-scheme: dark) {
border: 1px solid white;
background-color: oklch(14.5% 0 0deg);
color: oklch(14.5% 0 0deg);
}
&[data-checked],
&[data-indeterminate] {
background-color: oklch(14.5% 0 0deg);
color: white;
@media (prefers-color-scheme: dark) {
background-color: white;
color: oklch(14.5% 0 0deg);
}
}
&:focus-visible {
outline: 2px solid oklch(14.5% 0 0deg);
outline-offset: 2px;
@media (prefers-color-scheme: dark) {
outline-color: white;
}
}
}
.Indicator {
display: flex;
&[data-unchecked] {
display: none;
}
}
```
```tsx
/* docs-comparison.tsx */
import { StencilComparison } from 'docs/src/components/StencilComparison';
import ReactCheckboxGroup from './react-checkbox-group';
import StencilCheckboxGroup from './stencil-checkbox-group';
export default function CheckboxGroupComparison() {
return
Apples
Fuji
Gala
Granny Smith
);
}
function CheckIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
```
```tsx
/* stencil-checkbox-group.tsx */
import type * as React from 'react';
import './stencil.css';
export default function StencilCheckboxGroup() {
const id = 'stencil-apples-css-modules';
return (
Apples
Fuji
Gala
Granny Smith
);
}
function CheckIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
```
```css
/* stencil.css */
/* Example layout and visual exceptions. Default component styles come from the theme. */
@layer fs-theme {
.demo-checkbox-group-hero-caption {
font-size: var(--fs-font-size-sm);
line-height: var(--fs-line-height-sm);
font-weight: var(--fs-font-weight-bold);
}
}
```
## Usage guidelines
- **Form controls must have an accessible name**: It can be created using `` elements, or the `Field` and `Fieldset` components. See [Labeling a checkbox group](/react/components/checkbox-group.md) and the [forms guide](/react/handbook/forms.md).
## Anatomy
Checkbox Group is composed together with [Checkbox](/react/components/checkbox.md). Import the components and place them together:
```jsx title="Anatomy"
import { Checkbox } from '@base-ui/react/checkbox';
import { CheckboxGroup } from '@base-ui/react/checkbox-group';
;
```
## Examples
### Labeling a checkbox group
Label the group with `aria-labelledby` and a sibling label element:
```tsx title="Using aria-labelledby to label a checkbox group"
Allowed network protocols
{/* ... */}
```
An enclosing `` is the simplest labeling pattern for each checkbox:
```tsx title="Using an enclosing label to label a checkbox"
// @highlight
```
### Rendering as a native button
By default, `` renders a `` element to support enclosing labels. Prefer rendering each checkbox as a native button when using sibling labels (`htmlFor`/`id`).
```tsx title="Sibling label pattern with a native button"
Allowed network protocols
HTTP
{/* @highlight-text "nativeButton" "render={
```
Native buttons with wrapping labels are supported by using the `render` callback to avoid invalid HTML, so the hidden input is placed outside the label:
```tsx title="Render callback"
Allowed network protocols
(
)}
{/* @highlight-end */}
/>
```
### Form integration
Use [Field](/react/components/field.md) and [Fieldset](/react/components/fieldset.md) for group labeling and form integration:
```tsx title="Using Checkbox Group in a form"
```
### Parent checkbox
A checkbox that controls other checkboxes within a `` can be created:
1. Make `` a controlled component
2. Pass an array of all the child checkbox values to the `allValues` prop on the `` component
3. Add the `parent` boolean prop to the parent ``
The group controls the parent checkbox's [indeterminate](/react/components/checkbox.md) state when some, but not all, child checkboxes are checked.
## Demo
### CSS Modules
This example shows how to implement the component using CSS Modules.
```css
/* index.module.css */
.CheckboxGroup {
display: flex;
flex-direction: column;
align-items: start;
gap: 0.25rem;
color: oklch(14.5% 0 0deg);
@media (prefers-color-scheme: dark) {
color: white;
}
}
.Caption {
font-size: 0.875rem;
line-height: 1.25rem;
font-weight: 700;
}
.Item {
display: flex;
align-items: center;
gap: 0.5rem;
font-size: 0.875rem;
line-height: 1.25rem;
font-weight: 400;
}
.Checkbox {
box-sizing: border-box;
display: flex;
flex-shrink: 0;
width: 1rem;
height: 1rem;
align-items: center;
justify-content: center;
border: 1px solid oklch(14.5% 0 0deg);
border-radius: 0;
background-color: white;
color: white;
padding: 0;
margin: 0;
@media (prefers-color-scheme: dark) {
border: 1px solid white;
background-color: oklch(14.5% 0 0deg);
color: oklch(14.5% 0 0deg);
}
&[data-checked],
&[data-indeterminate] {
background-color: oklch(14.5% 0 0deg);
color: white;
@media (prefers-color-scheme: dark) {
background-color: white;
color: oklch(14.5% 0 0deg);
}
}
&:focus-visible {
outline: 2px solid oklch(14.5% 0 0deg);
outline-offset: 2px;
@media (prefers-color-scheme: dark) {
outline-color: white;
}
}
}
.Indicator {
display: flex;
&[data-unchecked] {
display: none;
}
}
```
```tsx
/* docs-comparison.tsx */
import { StencilComparison } from 'docs/src/components/StencilComparison';
import ReactCheckboxGroup from './react-checkbox-group';
import StencilCheckboxGroup from './stencil-checkbox-group';
import { StencilCheckboxGroupView } from './stencil-checkbox-group-view';
export default function CheckboxGroupComparison() {
return ([]);
return (
{state.indeterminate ? } />
Apples
Fuji
Gala
Granny Smith
);
}
function CheckIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
function HorizontalRuleIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
```
```tsx
/* stencil-checkbox-group.tsx */
'use client';
import * as React from 'react';
import { flushSync } from 'react-dom';
import { StencilCheckboxGroupView } from './stencil-checkbox-group-view';
export default function StencilCheckboxGroup() {
const id = React.useId();
const [value, setValue] = React.useState([]);
return (
{
// Commit this native custom event before another checkbox receives input.
flushSync(() => setValue(event.detail.value));
}}
/>
);
}
```
```tsx
/* stencil-checkbox-group-view.tsx */
import type * as React from 'react';
import type { CheckboxGroupValueChangeDetail } from 'finesoft-components/define-custom-elements';
import './stencil.css';
import './stencil-layout.css';
export const fruits = ['fuji-apple', 'gala-apple', 'granny-smith-apple'];
export function StencilCheckboxGroupView({
value = [],
id = 'stencil-apples-parent',
onValueChange,
}: {
value?: string[];
id?: string;
onValueChange?: (event: CustomEvent) => void;
}) {
return (
Apples
Fuji
Gala
Granny Smith
);
}
function CheckIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
function HorizontalRuleIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
```
```css
/* stencil.css */
/* Component skin comes from the optional theme; icon selection is in stencil-layout.css. */
```
```css
/* stencil-layout.css */
/* Example layout and visual exceptions. Default component styles come from the theme. */
@layer fs-theme {
.demo-checkbox-group-parent-layout-parent-indicator[data-indeterminate] > svg:first-of-type,
.demo-checkbox-group-parent-layout-parent-indicator:not([data-indeterminate]) > svg:last-of-type {
display: none !important;
}
}
```
### Nested parent checkbox
## Demo
### CSS Modules
This example shows how to implement the component using CSS Modules.
```css
/* index.module.css */
.CheckboxGroup {
display: flex;
flex-direction: column;
align-items: start;
gap: 0.25rem;
color: oklch(14.5% 0 0deg);
@media (prefers-color-scheme: dark) {
color: white;
}
}
.Caption {
font-size: 0.875rem;
line-height: 1.25rem;
font-weight: 700;
}
.Item {
display: flex;
align-items: center;
gap: 0.5rem;
font-size: 0.875rem;
line-height: 1.25rem;
font-weight: 400;
}
.Checkbox {
box-sizing: border-box;
display: flex;
flex-shrink: 0;
width: 1rem;
height: 1rem;
align-items: center;
justify-content: center;
border: 1px solid oklch(14.5% 0 0deg);
border-radius: 0;
background-color: white;
color: white;
padding: 0;
margin: 0;
@media (prefers-color-scheme: dark) {
border: 1px solid white;
background-color: oklch(14.5% 0 0deg);
color: oklch(14.5% 0 0deg);
}
&[data-checked],
&[data-indeterminate] {
background-color: oklch(14.5% 0 0deg);
color: white;
@media (prefers-color-scheme: dark) {
background-color: white;
color: oklch(14.5% 0 0deg);
}
}
&:focus-visible {
outline: 2px solid oklch(14.5% 0 0deg);
outline-offset: 2px;
@media (prefers-color-scheme: dark) {
outline-color: white;
}
}
}
.Indicator {
display: flex;
&[data-unchecked] {
display: none;
}
}
```
```tsx
/* docs-comparison.tsx */
import { StencilComparison } from 'docs/src/components/StencilComparison';
import ReactCheckboxGroup from './react-checkbox-group';
import StencilCheckboxGroup from './stencil-checkbox-group';
import { StencilCheckboxGroupView } from './stencil-checkbox-group-view';
export default function CheckboxGroupComparison() {
return ([]);
const [managementValue, setManagementValue] = React.useState([]);
return (
{
if (value.includes('manage-users')) {
setManagementValue(userManagementPermissions);
} else if (managementValue.length === userManagementPermissions.length) {
setManagementValue([]);
}
setMainValue(value);
}}
allValues={mainPermissions}
className={styles.CheckboxGroup}
style={{ marginLeft: '1rem' }}
>
0 && managementValue.length !== userManagementPermissions.length}>
{state.indeterminate ? } />
User Permissions
View Dashboard
Access Reports
{
if (value.length === userManagementPermissions.length) {
setMainValue(prev => Array.from(new Set([...prev, 'manage-users'])));
} else {
setMainValue(prev => prev.filter(v => v !== 'manage-users'));
}
setManagementValue(value);
}}
allValues={userManagementPermissions}
style={{ marginLeft: '1rem' }}
>
{state.indeterminate ? } />
Manage Users
Create User
Edit User
Delete User
Assign Roles
);
}
function CheckIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
function HorizontalRuleIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
```
```tsx
/* stencil-checkbox-group.tsx */
'use client';
import * as React from 'react';
import { flushSync } from 'react-dom';
import type { CheckboxGroupValueChangeDetail } from 'finesoft-components/define-custom-elements';
import { StencilCheckboxGroupView, userManagementPermissions } from './stencil-checkbox-group-view';
export default function StencilCheckboxGroup() {
const id = React.useId();
const [mainValue, setMainValue] = React.useState([]);
const [managementValue, setManagementValue] = React.useState([]);
const handleMainValueChange = (event: CustomEvent) => {
// Native custom events bubble; only handle this group's own request here.
if (event.target !== event.currentTarget) return;
const value = event.detail.value;
// Commit both groups together before the next native input event.
flushSync(() => {
if (value.includes('manage-users')) {
setManagementValue(userManagementPermissions);
} else if (managementValue.length === userManagementPermissions.length) {
setManagementValue([]);
}
setMainValue(value);
});
};
const handleManagementValueChange = (event: CustomEvent) => {
const value = event.detail.value;
flushSync(() => {
if (value.length === userManagementPermissions.length) {
setMainValue(prev => Array.from(new Set([...prev, 'manage-users'])));
} else {
setMainValue(prev => prev.filter(item => item !== 'manage-users'));
}
setManagementValue(value);
});
};
return (
) => void;
onManagementValueChange?: (event: CustomEvent) => void;
}) {
return (
0 && managementValue.length !== userManagementPermissions.length}>
User Permissions
View Dashboard
Access Reports
Manage Users
Create User
Edit User
Delete User
Assign Roles
);
}
function CheckIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
function HorizontalRuleIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
```
```css
/* stencil.css */
/* Component skin comes from the optional theme; icon selection is in stencil-layout.css. */
```
```css
/* stencil-layout.css */
/* Example layout and visual exceptions. Default component styles come from the theme. */
@layer fs-theme {
.demo-checkbox-group-nested-layout-parent-indicator[data-indeterminate] > svg:first-of-type,
.demo-checkbox-group-nested-layout-parent-indicator:not([data-indeterminate]) > svg:last-of-type {
display: none !important;
}
}
```
## API reference
### CheckboxGroup
Provides a shared state to a series of checkboxes.
**CheckboxGroup Props:**
| Prop | Type | Default | Description |
| :------------ | :------------------------------------------------------------------------------------------ | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| defaultValue | `string[]` | - | Names of the checkboxes in the group that should be initially ticked. To render a controlled checkbox group, use the `value` prop instead. |
| value | `string[]` | - | Names of the checkboxes in the group that should be ticked. To render an uncontrolled checkbox group, use the `defaultValue` prop instead. |
| onValueChange | `((value: string[], eventDetails: CheckboxGroup.ChangeEventDetails) => void)` | - | Event handler called when a checkbox in the group is ticked or unticked.
Provides the new value as an argument. |
| allValues | `string[]` | - | Names of all checkboxes in the group. Use this when creating a parent checkbox. |
| disabled | `boolean` | `false` | Whether the component should ignore user interaction. |
| className | `string \| ((state: CheckboxGroup.State) => string \| undefined)` | - | CSS class applied to the element, or a function that
returns a class based on the component's state. |
| style | `React.CSSProperties \| ((state: CheckboxGroup.State) => React.CSSProperties \| undefined)` | - | Style applied to the element, or a function that
returns a style object based on the component's state. |
| render | `ReactElement \| ((props: HTMLProps, state: CheckboxGroup.State) => ReactElement)` | - | Allows you to replace the component's HTML element
with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render. |
**CheckboxGroup Data Attributes:**
| Attribute | Type | Description |
| :------------ | :--- | :------------------------------------------- |
| data-disabled | - | Present when the checkbox group is disabled. |
### CheckboxGroup.Props
Re-export of [CheckboxGroup](/react/components/checkbox-group.md) props.
### CheckboxGroup.State
```typescript
type CheckboxGroupState = {
/** Whether the component should ignore user interaction. */
disabled: boolean;
/** Whether the field has been touched. */
touched: boolean;
/** Whether the field value has changed from its initial value. */
dirty: boolean;
/** Whether the field is valid. */
valid: boolean | null;
/** Whether the field has a value. */
filled: boolean;
/** Whether the field is focused. */
focused: boolean;
};
```
### CheckboxGroup.ChangeEventReason
```typescript
type CheckboxGroupChangeEventReason = 'none';
```
### CheckboxGroup.ChangeEventDetails
```typescript
type CheckboxGroupChangeEventDetails = {
/** The reason for the event. */
reason: 'none';
/** The native event associated with the custom event. */
event: Event;
/** Cancels Base UI from handling the event. */
cancel: () => void;
/** Allows the event to propagate in cases where Base UI will stop the propagation. */
allowPropagation: () => void;
/** Indicates whether the event has been canceled. */
isCanceled: boolean;
/** Indicates whether the event is allowed to propagate. */
isPropagationAllowed: boolean;
/** The element that triggered the event, if applicable. */
trigger: Element | undefined;
};
```
## Canonical Types
Maps `Canonical`: `Alias` — Use Canonical when its namespace is already imported; otherwise use Alias.
- `CheckboxGroup.State`: `CheckboxGroupState`
- `CheckboxGroup.Props`: `CheckboxGroupProps`
- `CheckboxGroup.ChangeEventReason`: `CheckboxGroupChangeEventReason`
- `CheckboxGroup.ChangeEventDetails`: `CheckboxGroupChangeEventDetails`