Prop | Default | Type |
---|---|---|
as | 'button' | AsTag | Component The element or component this component should render as. Can be overwritten by |
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. | |
defaultValue | boolean The pressed state of the toggle when it is initially rendered. Use when you do not need to control its open state. | |
disabled | false | boolean When |
modelValue | boolean | null The controlled pressed state of the toggle. Can be bind as | |
name | string The name of the field. Submitted with its owning form as part of a name/value pair. | |
required | boolean When |
Emit | Payload |
---|---|
update:modelValue | [value: boolean] Event handler called when the value of the toggle changes. |
Slots (default) | Payload |
---|---|
modelValue | boolean Current value |
state | 'on' | 'off' Current state |
pressed | boolean Current pressed state |
disabled | boolean Current disabled state |