Switch

A switch allow users to enter data by making a selection between two distinct and opposite states, such as “On” and “Off”.

UX/UI Guidelines

Check the design documentation of the component in ZeroHeight.

Implementations

The component Switch is available in the following technologies:

CSS Components

Web Components

Parameters

Parameters

Make sure you have read about the parameters in here.

The parametrization of the component can be done with the following custom params or properties:

Name	Type	Slot	Description
label	string	✅	Label of the input
model	boolean		Value of the model
checked	boolean		Overrides the "value" parameter as in the standard
disabled	boolean		Blocks the interaction with the input component by using the disabled attribute of the HTML input element.
required	boolean		Marks the input component as required. If and interaction is made with the input and the value is nullable or empty, the input will be marked as invalid as using the invalid attribute.
name	string		Identification for the field inside the form.
help-text	string	✅	The forced message to be shown under the input. It is used to give more information about the input, or a message to the user, specially when the input is invalid.
invalid	boolean		The attribute that forces the state of the input as invalid.
locale	string		The locale parameter is used to set the locale of the component. The value must be part of the registered locales in ZDS. If not set, the default locale of the document will be used. Have a look to the localization mechanisms.
custom	object		A record of key-value pairs to set the CSS custom tokens. It's a complex attribute set as an JS object in stringified JSON format. Example: <z-switch custom='{"fill":"#06e7a3"}' /> Check the available values in the customization section.
custom-str	string		The stringified version of the custom property. It follows the pattern key:value;key:value;, with the possibility of setting multiple values and spaces between the punctuation characters. Example: <z-switch custom-str="fill:#06e7a3" />
z-theme	string		Sets the theme of the component. The possible values are light and dark. <z-switch z-theme="dark" />

From Figma to code

You can check the Figma implementation here. This are the available properties:

• Type select
• State select

Customization

INFO

Check everything about the customization mechanics in the "How it works" documentation.

CSS Variable	Type	Description
--z-switch--thumb--on	color	The color of the thumb when the switch is on
--z-switch--thumb--off	color	The color of the thumb when the switch is off

The thumb of the switch can be customized for both states, checked and unchecked, using the --z-switch--thumb--on & --z-switch--thumb--off CSS custom properties, respectively.

Accessibility

...

Related components