Switch
<wa-switch>
Switches allow the user to toggle an option on or off.
<wa-switch>Switch</wa-switch>
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
Jump to heading
Checked
Jump to heading
Use the checked attribute to activate the switch.
<wa-switch checked>Checked</wa-switch>
Disabled
Jump to heading
Use the disabled attribute to disable the switch.
<wa-switch disabled>Disabled</wa-switch>
Sizes
Jump to heading
Use the size attribute to change a switch's size.
<wa-switch size="small">Small</wa-switch> <br /> <wa-switch size="medium">Medium</wa-switch> <br /> <wa-switch size="large">Large</wa-switch>
Hint
Jump to heading
Add descriptive hint to a switch with the hint attribute. For hints that contain HTML, use the hint slot instead.
<wa-switch hint="What should the user know about the switch?">Label</wa-switch>
Custom Styles
Jump to heading
Use the available custom properties to change how the switch is styled.
<wa-switch style="--width: 80px; --height: 40px; --thumb-size: 36px;">Really big</wa-switch>
Importing
Jump to heading
Autoloading components via projects is the recommended way to import components. If you prefer to do it manually, use one of the following code snippets.
Let your project code do the work! Sign up for free to use a project with your very own CDN — it's the fastest and easiest way to use Web Awesome.
To manually import this component from NPM, use the following code.
import '@awesome.me/webawesome/dist/components/switch/switch.js';
To manually import this component from React, use the following code.
import WaSwitch from '@awesome.me/webawesome/dist/react/switch';
Slots
Jump to heading
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
Jump to heading
Learn more about attributes and properties.
| Name | Description | Reflects | |
|---|---|---|---|
checked |
Draws the switch in a checked state.
Type
boolean |
||
css |
One or more CSSResultGroup to include in the component's shadow root. Host styles are automatically prepended.
Type
CSSResultGroup | undefinedDefault
[formControlStyles, sizeStyles, styles] |
||
customStates |
Methods for setting and checking custom states.
Type
objectDefault
{ /** Adds or removes the specified custom state. / set: (customState: string, active: boolean) => { if (!Boolean(this.internals?.states)) return; try { if (active) { this.internals.states.add(customState); } else { this.internals.states.delete(customState); } } catch (e) { if (String(e).includes("must start with '--'")) { / eslint-disable-next-line / console.error('Your browser implements an outdated version of CustomStateSet. Consider using a polyfill'); } else { throw e; } } }, /* Determines whether or not the element currently has the specified state. */ has: (customState: string) => { if (!Boolean(this.internals?.states)) return false; try { return this.internals.states.has(customState); } catch { return false; } }, } |
||
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
'small' | 'medium' | 'large'Default
'medium' |
|
|
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 |
Used for SSR. If you slot in hint, make sure to add
with-hint to your component to get it to properly render with SSR.Type
booleanDefault
false |
Methods
Jump to heading
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'
|
relayNativeEvent() |
Given a native event, this function cancels it and dispatches it again from the host element using the desired event options. |
event: Event,
eventOptions: EventInit
|
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
Jump to heading
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
Jump to heading
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
Jump to heading
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)
|
Need a hand?