Switch

A toggle input for turning options on or off. Clearly indicates state changes and allows quick, intuitive control.

Default

Labels

Get notified when something happens.
This has an icon.

Props

NameDefaultType
size
"sm""sm" | "md"

Size of the switch control

label
""string

Label text displayed next to the switch

description
""string

Helper or descriptive text shown below the label

disabled
falseboolean

Disables the switch and prevents interaction

icon
-any

Optional icon rendered inside or alongside the switch

labelClasses
""string

Custom classes applied to the label element

modelValue
falseboolean

Emit Events

EventPayload
update:modelValue
[value: boolean]

change
[value: boolean]