Skip to content

Boolean icon - Web Component

...

Browser support

Parameters

The Web component uses a <z-boolean-icon> tag.

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

NameTypeDescription
configstring?

Icon set to be used as a checkbox. The possible values are: star, heart, bookmark, like, dislike, lock, unlock, mute, unmute, sound-on, sound-off, visible, or invisible

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 events emitted from the component are:

NamePayloadDescription
onchangebooleanReturns the new value of the "value" attribute

Playground

Customization

HTML Examples

Imports
html
<link rel="stylesheet" href="/0.3.7/@zurich/web-components/styles.css" />
<script type="module" src="/0.3.7/@zurich/web-components/boolean-icon.js"></script>
<link rel="stylesheet" href="/0.3.7/@zurich/web-components/styles.css" />
Code
html
<z-boolean-icon config="star"></z-boolean-icon>
<z-boolean-icon config="star" disabled></z-boolean-icon>
<z-boolean-icon config="star" invalid-text="Invalid input"></z-boolean-icon>

<z-boolean-icon config="star" checked></z-boolean-icon>
<z-boolean-icon config="star" checked disabled></z-boolean-icon>
<z-boolean-icon config="star" checked invalid-text="Invalid input"></z-boolean-icon>

<z-boolean-icon config="star" label="Boolean icon"></z-boolean-icon>
<z-boolean-icon config="star" label="Boolean icon" disabled></z-boolean-icon>
<z-boolean-icon config="star" label="Boolean icon" invalid-text="Invalid input"></z-boolean-icon>      

<z-boolean-icon config="star" label="Boolean icon" checked></z-boolean-icon>
<z-boolean-icon config="star" label="Boolean icon" checked disabled></z-boolean-icon>
<z-boolean-icon config="star" label="Boolean icon" checked invalid-text="Invalid input"></z-boolean-icon>