Checkbox API

id

Unique identifier (auto-generated if not provided)

Default: useId()

label

Optional display label (passed through to slot)

value

Value associated with this checkbox (used in group mode and form submission)

name

Form field name - triggers auto hidden input when provided

form

Associate with form by ID

disabled

Disables this checkbox

Default: false

indeterminate

Sets the indeterminate state

Default: false

namespace

Namespace for context provision to children (Indicator, HiddenInput)

Default: "v0:checkbox:root"

groupNamespace

Namespace for connecting to parent Checkbox.Group

Default: "v0:checkbox:group"

ariaLabelledby

ID of element that labels this checkbox

ariaDescribedby

ID of element that describes this checkbox

ariaInvalid

Whether the checkbox has an invalid value

modelValue

update:model-value

default

namespace

Namespace for dependency injection

Default: "v0:checkbox:group"

disabled

Disables the entire checkbox group

Default: false

enroll

Auto-select non-disabled items on registration

Default: false

mandatory

Controls mandatory checkbox behavior: - false (default): No mandatory enforcement - true: Prevents deselecting the last selected item - `force`: Automatically selects the first non-disabled item on registration

Default: false

label

Accessible name for the group

ariaLabelledby

ID of element that labels this group

ariaDescribedby

ID of element that describes this group

modelValue

update:model-value

default

namespace

Namespace for context injection from parent Checkbox.Root

Default: "v0:checkbox:root"

name

Form field name (defaults to context value)

value

Submitted value when checked (defaults to context value or 'on')

form

Associate with form by ID (defaults to context value)

namespace

Namespace for context injection from parent Checkbox.Root

Default: "v0:checkbox:root"

default

label

Optional display label (passed through to slot and aria-label)

disabled

Disables this checkbox

namespace

Namespace for context provision to children (Indicator)

Default: "v0:checkbox:root"

groupNamespace

Namespace for connecting to parent Checkbox.Group

Default: "v0:checkbox:group"

ariaLabelledby

ID of element that labels this checkbox

ariaDescribedby

ID of element that describes this checkbox

default