| Prop | Default | Type |
|---|---|---|
as | 'div' | AsTag | ComponentThe element or component this component should render as. Can be overwritten by |
asChild | booleanChange the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details. | |
defaultValue | AcceptableValue[]The value of the checkbox when it is initially rendered. Use when you do not need to control its value. | |
dir | 'ltr' | 'rtl'The direction of navigation between items. | |
disabled | booleanWhen | |
loop | booleanWhether keyboard navigation should loop around | |
modelValue | AcceptableValue[]The controlled value of the checkbox. Can be binded with v-model. | |
name | stringThe name of the field. Submitted with its owning form as part of a name/value pair. | |
orientation | 'vertical' | 'horizontal'The orientation of the group. Mainly so arrow navigation is done accordingly (left & right vs. up & down) | |
required | booleanWhen | |
rovingFocus | true | booleanWhen |
| Emit | Payload |
|---|---|
update:modelValue | [value: AcceptableValue[]]Event handler called when the value of the checkbox changes. |
