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:

NameTypeDescriptionSlotA11y
optionsobject[]List of options
labelstringLabel of the inputlabel
valuebooleanValue of the model
checkedbooleanOverrides the "value" parameter as in the standard
invalid-textstringThe text to be shown when invalidinvalid-text
disabledbooleanBlocks the interaction with the input component.
requiredbooleanMarks the input component as required.
namestringIdentification for the field inside the form

Events ​

This component has events. Check the documentation about how to use the events.

Slots ​

This component has slots. Check the documentation about how to use the slots.

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.

value ​

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.

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.

name ​

The z-checkbox-group component accepts a name attribute to set the name of the component.

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

HTML Examples ​

CodeSandbox example ​