Toggle
Overview
A toggle is used to quickly switch between two possible states. They are commonly used for “on/off” switches.
Demo
Props
| Property | Description | Type | Values | Default | Required |
|---|---|---|---|---|---|
| label | The toggle label | string | string | ✓ | |
| name | The name for the input | string | undefined | string | undefined | ||
| hideLabel | Hides the Label | boolean | undefined | boolean | undefined | ||
| immediate | Does the toggle have an immediate effect. Should be false if part of a form | boolean | undefined | boolean | undefined | ||
| disabled | Disable the toggle | boolean | undefined | boolean | undefined | ||
| modelValue | boolean | undefined | boolean | undefined | false |
Events
| Name | Return Type |
|---|---|
| update:modelValue | [value: boolean] |