CheckboxGroup

A group of checkboxes with a shared label, supporting vertical and horizontal layouts and controlled selection.

Basic

Prop	Type	Default	Description
`label`	`string`	—	Label displayed above the group.
`value`	`string[]`	—	The selected values (controlled).
`defaultValue`	`string[]`	—	The initial selected values (uncontrolled).
`onValueChange`	`(value: string[]) => void`	—	Called when the selected values change.
`orientation`	`"vertical" \| "horizontal"`	`"vertical"`	Layout direction of the checkboxes.
`color`	`"blue" \| "red" \| "green" \| "yellow" \| "purple" \| "neutral" \| string`	`"blue"`	Accent color applied to all checkboxes in the group.
`--mantle-bg`	`CSS variable`	`theme default`	Override the background color via style. e.g. style={{ "--mantle-bg": "#1a1a2e" }}
`--mantle-border`	`CSS variable`	`theme default`	Override the border color via style. Set to "transparent" to remove. e.g. style={{ "--mantle-border": "#e94560" }}
`--mantle-text`	`CSS variable`	`theme default`	Override the text color via style. e.g. style={{ "--mantle-text": "#ffffff" }}
`--mantle-ring`	`CSS variable`	`accent`	Override the focus ring color via style. e.g. style={{ "--mantle-ring": "#e94560" }}

label

string

Label displayed above the group.

value

string[]

The selected values (controlled).

defaultValue

string[]

The initial selected values (uncontrolled).

onValueChange

(value: string[]) => void

Called when the selected values change.

orientation"vertical"

"vertical" | "horizontal"

Layout direction of the checkboxes.

color"blue"

Accent color applied to all checkboxes in the group.

--mantle-bgtheme default

CSS variable

Override the background color via style. e.g. style={{ "--mantle-bg": "#1a1a2e" }}

--mantle-bordertheme default

CSS variable

Override the border color via style. Set to "transparent" to remove. e.g. style={{ "--mantle-border": "#e94560" }}

--mantle-texttheme default

CSS variable

Override the text color via style. e.g. style={{ "--mantle-text": "#ffffff" }}

--mantle-ringaccent

CSS variable

Override the focus ring color via style. e.g. style={{ "--mantle-ring": "#e94560" }}