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

The controlled state of the switch. Can be bind as v-model:checked.

defaultChecked
boolean

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

disabled
boolean

When true, prevents the user from interacting with the switch.

id
string
name
string

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

required
boolean

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

value
'on'
string

The value given as data when submitted with a name.

EmitPayload
update:checked
[payload: boolean]

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

Slots (default)Payload
checked
boolean

Current checked state