Skip to content

Selection

Checkbox Card Group

In progress

A list of Checkbox Cards that share one control position, available on web (React) and native (React Native). The group owns controlPosition, so siblings in a list cannot disagree.

Control position

The group sets controlPosition once and every card inside it follows. right is the default.

Control on the right (default)

Each card keeps its own state; only the control side comes from the group.

<CheckboxCardGroup label="Notifications">
<CheckboxCard label="Email" body="We will email you when a job is booked." />
<CheckboxCard label="Text message" defaultChecked />
<CheckboxCard label="Post" disabled />
</CheckboxCardGroup>

Control on the left

Set controlPosition to left on the group to move every card's control to the leading side.

<CheckboxCardGroup label="Notifications" controlPosition="left">
<CheckboxCard label="Email" body="Every card puts its control on the left." />
<CheckboxCard label="Text message" defaultChecked />
<CheckboxCard label="Post" disabled />
</CheckboxCardGroup>

When to use

Use a checkbox card group when a list of checkbox cards should agree on where their controls sit. The group is the only way to put a checkbox card’s control on the left: a standalone CheckboxCard is always right-aligned.

It does not manage selection. Each card keeps its own checked or defaultChecked state, so a group is a layout and naming wrapper, not a selection model.

When not to use

  • A single checkbox card: use CheckboxCard on its own. It is already right-aligned.
  • One exclusive choice: use RadioCard, where the group owns the selection as well as the layout.
  • No cards involved: a plain list of Checkbox controls uses the Checkbox Group pattern instead.

Accessibility

  • The group renders a role="group" container named by label, or by aria-labelledby when that is supplied.
  • Each card keeps its own checkbox input, focus stop and accessible name; the group adds no focusable node.
  • controlPosition is visual only. It flips the row with flexDirection: row-reverse, so the control stays last in the tree and the tab order is unchanged. (Design, Oliver Maton, 2026-11-19)

Props

Prop Type Default Description
controlPosition 'left' | 'right' 'right' Which side every card in the group puts its control on. Set here, never per card, so siblings cannot disagree.
label string - Accessible name for the group. Not drawn on screen.
aria-labelledby string - Web only. Names the group from a visible heading. Takes precedence over label.
testID string - Native only. Test identifier for the group container.
children ReactNode - The Checkbox Cards. Each one keeps its own size and state.

Import

Web

import { CheckboxCard, CheckboxCardGroup } from '@checkatrade/components-web';

Native

import { CheckboxCard, CheckboxCardGroup } from '@checkatrade/components-native';

Basic usage

<CheckboxCardGroup label="Notifications" controlPosition="left">
  <CheckboxCard label="Email" body="We will email you when a job is booked." />
  <CheckboxCard label="Text message" defaultChecked />
</CheckboxCardGroup>

Platform status

Platform / AreaStatus
Design (Figma) Planned
Web (React) In Progress
Native (React Native) In Progress
iOS (Swift) Planned
Android (Kotlin) Planned
Accessibility audit Planned

There is no Figma component for the group yet. The group is a layout container around cards that do have specs, and the control side is a design decision recorded with the checkbox cards.

Known gaps

  • The group has no Figma component, so it has no Code Connect mapping.
  • The gap between cards is fixed at 8px and there is no className or style escape hatch.

No releases yet.

Select a brand to demo:
Active brand: checkatrade