Skip to content

Switch - Web Component

Browser support

Detected engine:  

  • Chromium

  • Webkit

  • Gecko

Parameters

The Web component uses the <z-switch> tag:

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

NameTypeDescription
label
(optional)
stringLabel of the input
value
(optional)
booleanValue of the model
checked
(optional)
booleanOverrides the "value" parameter as in the standard
disabled
(optional)
booleanBlocks the interaction with the input component.
required
(optional)
booleanMarks the input component as required.
name
(optional)
stringIdentification for the field inside the form
invalid
(optional)
booleanThe forced state for set the input as invalid

The available slots for the component are:

NameTagsDescription
defaultspan

label

The z-switch component accepts a label attribute to set the text label of the component.

value & checked

Both value and checked parameters are used to set the value of the component.

disabled

The attribute disabled will block the interaction with the component.

required

The attribute required will set the component as required.

name

The name attribute is used to set the name of the component. This is useful when the component is inside a form.

invalid-text

The invalid-text attribute will set the component as invalid. Without label, the text won't be present but the switch will still be invalid,

Playground

Customization

HTML Examples

Imports
html
<link rel="stylesheet" href="/0.5.1/@zurich/web-components/styles.css" />
<script type="module" src="/0.5.1/@zurich/web-components/switch.js"></script>
Code
html
<!-- Default -->
<z-switch checked></z-switch>
<z-switch checked label="Switch"></z-switch>

<!-- Disabled -->
<z-switch disabled checked></z-switch>
<z-switch disabled checked label="Switch"></z-switch>

<!-- Invalid -->
<z-switch invalid-text="Invalid input" checked></z-switch>
<z-switch invalid-text="Invalid input" checked label="Switch"></z-switch>