Skip to content 
Checkbox group - Web Component
The CheckboxGroup component can be used imported from:
Playground
Parameters
The Web component uses the <z-checkbox-group> tag:
By default, all the parameters are optional or can be set in different, except for the ones marked as required
The parametrization of the component can be done with the following custom HTML params:
| Name | Type | Description | Slot | A11y |
|---|---|---|---|---|
options | object[] | List of options | ||
label | string | Label of the input | label | |
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. | ||
required | boolean | Marks the input component as required. | ||
name | string | Identification for the field inside the form | ||
help-text | string | The forced message to be shown under the input | help-text | |
invalid | boolean | The forced state for set the input as invalid |
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 |
Slots
This component has slots. Check the documentation about how to use the slots.
| Name | Tags | Description |
|---|---|---|
label | span |
Parameters use
options
The z-checkbox-group component accepts an options attribute to set the options of the component. The options attribute should be an array of objects with the following properties:
text(string): The text label of the checkbox.disabled(boolean): Whether the checkbox is disabled.
We can use <option> tags to define the values of options
label
The z-checkbox-group component accepts a label attribute to set the text label of the component.
model
The z-checkbox-group component accepts a value attribute to set the value of the component. The value attribute should be an array of booleans, matching the number of options.
name
The z-checkbox-group component accepts a name attribute to set the name of the component.
Flags
disabled
You can disable the z-checkbox-group component by adding the disabled attribute.
required
You can make the z-checkbox-group component required by adding the required attribute.
invalid
You can set the z-checkbox-group component to an invalid state by adding the invalid attribute.
TIP
The difference between the CheckboxSelect and the CheckboxGroup components is that, in the CheckboxSelect component, returns an array of values, while the CheckboxGroup component returns an array of booleans.
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:
[false,false,false]The reset is done to an array of false (based on options).
Browser support
Detected engine:
Chromium
Webkit
Gecko