Checkbox

Overview

A checkbox built on Reka UI's CheckboxRoot, displaying a check icon when checked and a minus icon when indeterminate.

Theme entry: Checkbox

Props

Name	Type	Required	Default	Description
iconOverride	Object		null	A partial icon registry ({ [componentName]: { [iconName]: { component, props } } }) merged with inherited and default icon entries; scopes icon overrides to this component and its descendants.
themeOverride	Object		null	A partial ThemeObject keyed by component name, merged over this component's theme and provided to descendants.
class	string|array|object		undefined	Additional CSS classes to apply to the checkbox root.
defaultValue	boolean|string		undefined	The default checked state when uncontrolled.
modelValue	boolean|string		undefined	The controlled checked state (used with v-model).
disabled	boolean		undefined	Whether the checkbox is disabled.
value	string		undefined	The value submitted with a form when checked.
id	string		undefined	The id applied to the underlying input element.
trueValue	boolean|string		undefined	The value representing the checked state.
falseValue	boolean|string		undefined	The value representing the unchecked state.
as	string|object		undefined	The element or component to render as.
asChild	boolean		false	When true, merges props onto the child element instead of rendering a wrapper.
name	string		undefined	The name submitted with a form.
required	boolean		undefined	Whether the field is required.

Slots

default

Scoped slot.

Events

Name	Description
update:modelValue	Emitted when the value changes.

Full event reference

Source

client/lib/controls/checkbox/Checkbox.vue