Checkbox select - Web Component

The CheckboxSelect component can be used imported from:

Playground

Parameters

The Web component uses the <z-checkbox-select> 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
`options`	`object[]`	List of options
`label`	`string`	Label of the input	`label`
`value`	`boolean`	Value of the model
`checked`	`boolean`	Overrides the "value" parameter as in the standard
`invalid-text`	`string`	The text to be shown when invalid	`invalid-text`
`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

Events

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

Name	Payload	Description
`change`	`string[]`	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-select 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.
value (string): The value 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-select component accepts a label attribute to set the text label of the component.

`value`

The z-checkbox-select 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-select component by adding the disabled attribute.

`required`

You can make the z-checkbox-select component required by adding the required attribute.

`name`

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

`invalid`

You can set the z-checkbox-select 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.

Checkbox select - Web Component ​

Playground ​

Parameters ​

Events ​

Slots ​

Parameters use ​

options ​

label ​

value ​

disabled ​

required ​

name ​

invalid ​

Browser support ​

HTML Examples ​

CodeSandbox example ​