| 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 | booleanThe state of the switch when it is initially rendered. Use when you do not need to control its state. | |
disabled | booleanWhen | |
id | string | |
modelValue | boolean | nullThe controlled state of the switch. Can be bind as | |
name | stringThe name of the field. Submitted with its owning form as part of a name/value pair. | |
required | booleanWhen | |
value | 'on' | stringThe value given as data when submitted with a |
| Emit | Payload |
|---|---|
update:modelValue | [payload: boolean]Event handler called when the value of the switch changes. |
| Slots (default) | Payload |
|---|---|
modelValue | booleanCurrent value |
