Skip to content

CheckboxGroup

Multi-select from a list of options. Renders a role="group" with a fieldset semantics.

Basic usage

Fruit
Example

Horizontal layout

Fruit

API

Props

NameTypeDefaultDescription
valueCheckboxGroupValue() => []
optionsArray() => []
labelstring""
assistiveTextstring""
alertMessagestring""
stateDataEntryState"default"
alignmentCheckboxGroupAlignment"flex"
disabledbooleanfalse
hueEpHue"information"
sizeEpSizeundefined
ariaLabelstringundefined
namestringundefined

Events

EventPayloadDescription
update:value{"names":["CheckboxGroupValue"]}
change{"names":["CheckboxGroupValue"]}

Slots

SlotScopeDescription
default

Released under the MIT License. Built with VitePress.