Skip to content 
Favorite
This is a help text This is a help text
Boolean icon - Web Component
The BooleanIcon component can be used imported from:
Playground
Parameters
...
Common API
For the basics, check the common specifications.
Events
This component has events. Check the documentation about how to use the events.
| Name | Payload | Description |
|---|---|---|
change | boolean | Returns the new value of the "value" attribute |
restarted | void | Emitted on value reset |
blur | void | Emitted on blur |
validated | boolean | Emitted when the validation status changes |
Slots
This component has slots. Check the documentation about how to use the slots.
| Name | Tags | Description |
|---|---|---|
label | span | Label for the input |
help-text | span | Help message |
Parameters use
config
The config paramater requires the name of the 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
The z-boolean-icon parameter accepts a label attribute to set the text label of the component.
The slot label can also be used:
model
Both model and checked parameters are used to set the value of the component.
Attention!
If you hardcode this value, it will not be reactive and the selection won't change. Use a variable instead and, ideally, a closed loop.
name
The attribute name will set the name of the component. This is useful when the component is part of a form.
help-text
The help-text attribute will provide a text if a label is used:
We can also use the help-text slot:
Flags
disabled
The attribute disabled will block the interaction with the component.
And with label:
required
The attribute required will set the component as required.
The default text adapts to the localization:
invalid
The invalid attribute will set the component as invalid. If a label is present a default text will be shown unless is overwritten using help-text.
The default text adapts to the localization:
Methods
reset()
We can all the reset() method of the WebComponent in order to reset the value. This will clean the internal states and emit the nullable value with the change event, plus a restarted event:
In this example, the button triggers the method:
Value:
falseBrowser support
Detected engine:
Chromium
Webkit
Gecko