Skip to content 
Checkbox group
CheckboxGroup ⚠️ Experimental
The CheckboxGroup component can be used imported from:
Playground
Parameters
Events
This component has events. Check the documentation about how to use the events.
| Name | Payload | Description |
|---|---|---|
onChange | boolean[] | Returns the new value of the model |
onRestarted | 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
Check the documentation about how to use the parameters.
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
We can use slots to define the content of the cards with the option-<value> slot.
model
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.
The z-checkbox-group component accepts a model attribute to set the value of the component
The value attribute should be an array of booleans, matching the number of options.
label
The z-checkbox-group component accepts a label attribute to set the text label of the component.
We can also use the label slot:
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.
Browser support
Detected engine:
Chromium
Webkit
Gecko
CodeSandbox example
Sorry, not available yet ☹️