Skip to main content

Interface: CheckboxProps

Defined in: components/Checkbox/Checkbox.tsx:109

Props for the Checkbox component.

Extends​

  • Omit<RACCheckboxProps, "style" | "children">

Properties​

children?​

optional children?: ReactNode

Defined in: components/Checkbox/Checkbox.tsx:117

Label content displayed next to the checkbox indicator. Rendered inside a data-part="label" span.

description?​

optional description?: ReactNode

Defined in: components/Checkbox/Checkbox.tsx:122

Supporting hint under the label — a constraint, or what checking this actually commits the user to.

errorMessage?​

optional errorMessage?: ReactNode

Defined in: components/Checkbox/Checkbox.tsx:128

Validation message, shown only while the checkbox is invalid. Supply the copy: a checkbox's rule is domain-specific ("confirm you have read the terms"), which is not something the platform can phrase (ADR-001).