CheckboxGroup

A named set of checkboxes sharing one value, the list of what's checked. Each option is a row, the checkbox and its words, the whole row a target. parent adds a checkbox that checks or clears them all and shows a dash when only some are on. Built on Base UI CheckboxGroup with Echo's Checkbox.

Feel A column of small keys that latch with a drawn tick, each with its words beside it.

Email me aboutEverything

MentionsRepliesWeekly digestMondays, 9am

Or let the agent fetch it: get_component("checkbox-group") on the Echo MCP server.

Installation

npx echo-ui-cli add checkbox-group

First time? Run npx echo-ui-cli init once — it sets the project up, and add refuses to run before it.

At a glance

Version: 0.3.0
Weight: 1.4 KB · 39.4 KB with what it imports · 1.1 KB of CSS (minified and gzipped; React not counted)
Needs: @base-ui/react, checkbox (Echo, brought with it)
Keyboard: The whole row toggles its box; Space toggles a focused box.
Reduced motion: The tick appears without being drawn.
Sound: Each checkbox's select, inside a SoundProvider.

Usage

tsx

import { CheckboxGroup } from "@/echo/checkbox-group";

<CheckboxGroup label="Show" options={options} />

Composition

CheckboxGroup → a named group of Checkbox rows (Base UI CheckboxGroup)

Examples

Notifications

With a parent that sets them all.

tsx

<CheckboxGroup
  label="Email me about"
  parent="Everything"
  options={[
    { value: "mentions", label: "Mentions" },
    { value: "replies", label: "Replies" },
    { value: "digest", label: "Weekly digest", description: "Mondays, 9am" },
  ]}
  defaultValue={["mentions"]}
/>

Accessibility

A group named by its visible label; each checkbox is named by its row's words.
The whole row toggles its box; Space toggles a focused box.
The parent checkbox is mixed (a dash) while only some are checked.

Tested against WCAG 2.2 AA on every release:

axe — No axe violations, in the component's own gallery and on its page.
keyboard — Every action is reachable and operable from the keyboard alone.
focus-visible — Focus is visible on every focusable part, in normal and forced-colors mode.
forced-colors — State stays visible when the look's colours are replaced by the system's.
target-size — Every target's real hit area is at least 24×24px, at every density.
reflow — Content reflows into 320px and survives a doubled text size.

Not covered: screen-reader: not yet verified by a person. Everything above is a machine check; a person has not yet driven this component with a screen reader.

Motion & sound

Reduced motion: The tick appears without being drawn.
Sound: Each checkbox's select, inside a SoundProvider.

Props

CheckboxGroup props
Prop	Type	Default
`id`The element's id, so a <label for> or an aria-describedby can reach it.	`string`
`name`Posted with a form, one value per checked box.	`string`
`disabled`	`boolean`	`false`
`required`	`boolean`
`readOnly`	`boolean`
`autoFocus`Focus this control when it mounts. One per page, at most.	`boolean`
`onBlur`Fired on focus loss. react-hook-form validates onTouched and onBlur with it.	`function`
`onFocus`Fired when the control takes focus.	`function`
`onKeyDown`Keyboard handling you own — Enter to send, Escape to clear. Runs before Echo's.	`function`
`label` requiredThe group's name, shown above it.	`string`
`options` requiredOne checkbox each: its words, and a line under them.	`object[]`
`value`	`string[]`
`defaultValue`	`string[]`
`onValueChange`	`function`
`parent`A checkbox above the rest that checks or clears them all, and shows a dash when only some are on.	`string`

Anti-patterns

Never use a CheckboxGroup where only one can be chosen: that's RadioGroup.
Never leave a parent without saying what it covers ("Everything", "All channels").

Changelog

v0.3.0 · 2026-10-12 · ChangedEvery item needs echo-ui-core 0.3.0 (all components). The drawn device, readability past AA and the design tests live in core, and the components that use them are built against it, so each item now declares echo-ui-core >=0.3.0 <0.4.0. Update core with the items: npm install echo-ui-core@^0.3.0 (or your package manager's), then npx echo-ui-cli update. An item whose files didn't change is the same code under a new version; the 0.2.0 files stay published.
v0.2.0 · 2026-10-04 · AddedChoosing: Combobox, TagsInput, ChoiceCards, CheckboxGroup, Fieldset, Form and HoldButton. - Combobox: a Select you can type into. multiple keeps choices as tags that bud out of the text line; creatable offers to add what you typed. Built on Base UI Combobox. - TagsInput: free-form tags in Field's well (Enter or a comma adds, Backspace takes the last back, a paste becomes several), with normalize to clean or refuse each one. - ChoiceCards: options that need more than a word, as cards; the chosen one lights a rail and drops its pip. One choice is a radio group, multiple a group of checkboxes. - CheckboxGroup: a named set of checkboxes with an optional parent that shows a dash when only some are on. - Fieldset: a named group of fields with a legend. - Form: fails well. Pass errors to it and to each field; after a failed submit a summary at the top takes focus, counts the problems and links each to its field. - HoldButton: confirm by holding; the cap fills while pressed and drains if let go. A press that can't hold (assistive tech) arms it and a second press confirms.
v0.2.0 · 2026-10-04 · ChangedComments only, no behaviour change. Comments in the component source used to cite documents, milestones and ticket numbers from Echo's own planning, none of which exist in your project. The citations are gone and the sentences around them stay. Where a comment was only a citation, it now says what it meant. Three development warnings (HardwareButton's engraved/caption checks and StatusDot's missing-label check) also dropped the ticket code at the end of the message. echo-ui diff will show changes in most items; none of them are to code.
v0.2.0 · 2026-10-04 · ChangedAn item's version is now a function of declared data, not of how the changelog is formatted. The version an item ships under is published once and never rewritten, and it used to be inferred from prose: a regex for a bolded "Breaking" run across the whole unreleased section, and attribution by "does a bullet mention this name in backticks". One breaking entry therefore moved every item that changed that cycle, and an entry explaining that "Menu and Sheet are unchanged here" filed itself as a change to Menu and Sheet — which it really had.
v0.2.0 · 2026-10-04 · ChangedThe agent brief says Echo has not shipped. llms.txt and the MCP server's instructions led with npx echo-ui-cli init, and that name on npm is a reserved stub with no executable — so a model following the brief wrote an install step that fails with npx's own error. The brief now opens with the caveat, and the docs carry it on every surface that shows a command. One switch (CLI_RELEASED) silences all of them at launch, and a test refuses to let one move without the others. Affects all components only in what the brief says about installing them; no item's props, CSS or rendered semantics change.
v0.2.0 · 2026-10-04 · ChangedEcho's home is echo-ui.com. The registry, the docs and the packages all move to it from echo.nawwara.studio. Nothing was published under the old host, so no echo.json anywhere points at it and there is nothing to migrate — this is the last release where that is true.
v0.2.0 · 2026-10-04 · ChangedWeights, line heights, letter-spacing, z-index, border widths and icon sizes come from the theme scales in all components, with the old value as a fallback, so components keep working with echo-ui-core@0.0.1. Strays moved to the nearest step: most by under a pixel; HardwareButton icons are 14/16/20px (were 15/17/19).
v0.2.0 · 2026-10-04 · FixedContent now reflows into a 320px screen (400% zoom) and survives a doubled browser text size (WCAG 1.4.10, 1.4.4), across all components. Select's 180px floor, NumberField's readout, Segmented and Steps as flex items, EmptyState's grid columns, and Avatar's fixed-pixel disc all gave way; Panel counts its padding inside a width you set (box-sizing: border-box), so a <Panel style={{ width: 220 }}> is now 220px wide overall rather than 260px.

Preview