Switch
<wa-switch>
Switches toggle a single setting on or off and apply the change immediately, without requiring a form submission.
This component works with standard <form> elements. Please refer to the section on form controls to learn more about form submission and client-side validation.
Examples
Checked
Use the checked attribute to activate the switch.
The checked attribute is the initial value and does not reflect changes, consistent with native checkboxes. To toggle the checked state with JavaScript, use the checked property instead. To target checked switches with CSS, use the :state(checked) selector.
Disabled
Use the disabled attribute to disable the switch.
Sizes
Use the size attribute to change a switch's size.
Hint
Add descriptive hint to a switch with the hint attribute. For hints that contain HTML, use the hint slot instead.
Custom Styles
Use the available custom properties to change how the switch is styled.
Importing
If you're using the autoloader or a hosted project, components load on demand — no manual import needed. To cherry-pick a component manually, use one of the following snippets.
Import this component directly from the CDN:
import 'https://ka-f.webawesome.com/[email protected]/components/switch/switch.js';
After installing Web Awesome via npm, import this component:
import '@awesome.me/webawesome/dist/components/switch/switch.js';
If you're self-hosting Web Awesome, import this component from your server:
import './webawesome/dist/components/switch/switch.js';
To import this component for React 18 or below, use the following code:
import WaSwitch from '@awesome.me/webawesome/dist/react/switch/index.js';
Slots
Learn more about using slots.
| Name | Description |
|---|---|
| (default) | The switch's label. |
hint
|
Text that describes how to use the switch. Alternatively, you can use the hint attribute. |
Attributes & Properties
Learn more about attributes and properties.
| Name | Description | Reflects | |
|---|---|---|---|
checked |
Draws the checkbox in a checked state.
|
||
css |
One or more CSSResultGroup to include in the component's shadow root. Host styles are automatically prepended.
Type
CSSResultGroup | undefinedDefault
[formControlStyles, sizeStyles, styles] |
||
defaultCheckedchecked |
The default value of the form control. Primarily used for resetting the form control.
Type
boolean |
|
|
disableddisabled |
Disables the switch.
Type
booleanDefault
false |
||
form |
By default, form controls are associated with the nearest containing
<form> element. This attribute allows you
to place the form control outside of a form and associate it with the form that has this id. The form must be in
the same document or shadow root for this to work.Type
HTMLFormElement | null |
||
hinthint |
The switch's hint. If you need to display HTML, use the
hint slot instead.Type
stringDefault
'' |
||
namename |
The name of the switch, submitted as a name/value pair with form data.
Type
string | nullDefault
null |
|
|
requiredrequired |
Makes the switch a required field.
Type
booleanDefault
false |
|
|
sizesize |
The switch's size.
Type
'xs' | 's' | 'm' | 'l' | 'xl' | 'small' | 'medium' | 'large'Default
'm' |
|
|
validationTarget |
Override this to change where constraint validation popups are anchored.
Type
undefined | HTMLElement |
||
validators |
Validators are static because they have
observedAttributes, essentially attributes to "watch"
for changes. Whenever these attributes change, we want to be notified and update the validator.Type
Validator[]Default
[] |
||
valuevalue |
The value of the switch, submitted as a name/value pair with form data.
Type
string | null |
|
|
withHintwith-hint |
Only required for SSR. Set to
true if you're slotting in a hint element so the server-rendered markup
includes the hint before the component hydrates on the client.Type
booleanDefault
false |
Methods
Learn more about methods.
| Name | Description | Arguments |
|---|---|---|
blur() |
Removes focus from the switch. | |
click() |
Simulates a click on the switch. | |
focus() |
Sets focus on the switch. |
options: FocusOptions
|
formStateRestoreCallback() |
Called when the browser is trying to restore element’s state to state in which case reason is "restore", or when the browser is trying to fulfill autofill on behalf of user in which case reason is "autocomplete". In the case of "restore", state is a string, File, or FormData object previously set as the second argument to setFormValue. |
state: string | File | FormData | null,
reason: 'autocomplete' | 'restore'
|
resetValidity() |
Reset validity is a way of removing manual custom errors and native validation. | |
setCustomValidity() |
Do not use this when creating a "Validator". This is intended for end users of components. We track manually defined custom errors so we don't clear them on accident in our validators. |
message: string
|
Events
Learn more about events.
| Name | Description |
|---|---|
blur |
Emitted when the control loses focus. |
change |
Emitted when the control's checked state changes. |
focus |
Emitted when the control gains focus. |
input |
Emitted when the control receives input. |
wa-invalid |
Emitted when the form control has been checked for validity and its constraints aren't satisfied. |
CSS custom properties
Learn more about CSS custom properties.
| Name | Description |
|---|---|
--height |
The height of the switch.
|
--thumb-size |
The size of the thumb.
|
--width |
The width of the switch.
|
CSS parts
Learn more about CSS parts.
| Name | Description | CSS selector |
|---|---|---|
base |
The component's base wrapper. |
::part(base)
|
control |
The control that houses the switch's thumb. |
::part(control)
|
hint |
The hint's wrapper. |
::part(hint)
|
label |
The switch's label. |
::part(label)
|
thumb |
The switch's thumb. |
::part(thumb)
|