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.

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 true, prevents the user from interacting with the toggle.

pressed
boolean

The controlled pressed state of the toggle. Can be bind as v-model.

EmitPayload
update:pressed
[value: boolean]

Event handler called when the pressed state of the toggle changes.

Slots (default)Payload
pressed
boolean

Current pressed state