| Prop | Default | Type |
|---|---|---|
as | 'button' | 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 | boolean | 'indeterminate'The value of the checkbox when it is initially rendered. Use when you do not need to control its value. | |
disabled | booleanWhen | |
id | stringId of the element | |
modelValue | boolean | 'indeterminate' | nullThe 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. | |
required | booleanWhen | |
value | 'on' | AcceptableValueThe value given as data when submitted with a |
| Emit | Payload |
|---|---|
update:modelValue | [value: boolean | 'indeterminate']Event handler called when the value of the checkbox changes. |
| Slots (default) | Payload |
|---|---|
modelValue | false | true | 'indeterminate'Current value |
state | CheckedStateCurrent state |
