Switch
Switches communicate an immediate on or off state and support optional checked and unchecked icon affordances.
Checked: false
Props
| Name | Description | Default | Control |
|---|---|---|---|
disabledOptional | Whether the switch is disabled. boolean | undefined | false | |
checkedIconOptional | Icon name displayed when checked. string | undefined | "check" | |
uncheckedIconOptional | Icon name displayed when unchecked. string | undefined | - | |
nameOptional | Name attribute for the native checkbox input. string | undefined | - | - |
valueOptional | Value attribute for the native checkbox input. string | undefined | - | - |
ariaLabelOptional | ARIA label forwarded to the native checkbox input. string | undefined | - | - |
checkedRequired | - boolean | - |
Events
| Name | Type | Description |
|---|---|---|
update:checked | [value: boolean] | - |
Slots
| Name | Parameters | Description |
|---|---|---|
default | - | Optional label content rendered next to switch. |
Default
Checked: false