Skip to main content

Interface: CheckboxGroupProps

Defined in: components/CheckboxGroup/CheckboxGroup.tsx:52

Props for the CheckboxGroup component.

Extends​

  • Omit<RACCheckboxGroupProps, "style" | "children" | "className">

Properties​

children?​

optional children?: ReactNode

Defined in: components/CheckboxGroup/CheckboxGroup.tsx:71

Checkbox option children.

contextualHelp?​

optional contextualHelp?: ReactNode

Defined in: components/CheckboxGroup/CheckboxGroup.tsx:62

A <ContextualHelp> element rendered beside the label (the reference system's prop shape) — for the explanation too long for description.

description?​

optional description?: ReactNode

Defined in: components/CheckboxGroup/CheckboxGroup.tsx:64

Supplementary helper text linked to the group via aria-describedby.

errorMessage?​

optional errorMessage?: ReactNode

Defined in: components/CheckboxGroup/CheckboxGroup.tsx:69

Validation message shown when the group is invalid (isInvalid / validate). Supply caller-localized copy (i18n rule / §6).

label?​

optional label?: ReactNode

Defined in: components/CheckboxGroup/CheckboxGroup.tsx:57

Group label displayed above the checkboxes.