Skip to content

Checkbox

Boolean (or tri-state via indeterminate) input.

Basic usage

Example

Indeterminate

Sizes

Accessibility

  • Renders a native <input type="checkbox"> for full assistive-tech support.
  • aria-checked="mixed" is applied automatically when indeterminate.
  • Space toggles state.

API

Props

NameTypeDefaultDescription
valueCheckboxValuefalse
labelstringundefined
disabledbooleanfalse
indeterminatebooleanfalse
sizeEpSizeundefined
hueEpHue"information"
ariaLabelstringundefined
describedBystringundefined
namestringundefined
nativeValueunionundefinedUsed when this checkbox is one of many sharing an array value

Events

EventPayloadDescription
update:value{"names":["CheckboxValue"]}
change{"names":["CheckboxValue"]}
focus{"names":["FocusEvent"]}
blur{"names":["FocusEvent"]}

Slots

SlotScopeDescription
default

Released under the MIT License. Built with VitePress.