Skip to content
PropDefaultType
as
'button'
AsTag | Component

The element or component this component should render as. Can be overwritten by asChild.

asChild
boolean

Change the default rendered element for the one passed as a child, merging their props and behavior.

Read our Composition guide for more details.

checked
boolean | 'indeterminate'

The controlled checked state of the checkbox. Can be binded with v-model.

defaultChecked
boolean

The checked state of the checkbox when it is initially rendered. Use when you do not need to control its checked state.

disabled
boolean

When true, prevents the user from interacting with the checkbox

id
string

Id of the element

name
string

The name of the checkbox. Submitted with its owning form as part of a name/value pair.

required
boolean

When true, indicates that the user must check the checkbox before the owning form can be submitted.

value
'on'
string

The value given as data when submitted with a name.

EmitPayload
update:checked
[value: boolean]

Event handler called when the checked state of the checkbox changes.

Slots (default)Payload
checked
false | true | 'indeterminate'

Current checked state