Checkbox

Checkboxes allow users to enter data by selecting one or more option.

UX/UI Guidelines

Check the design documentation of the component in ZeroHeight.

Implementations

The component Checkbox is available in the following technologies:

CSS Components

Web Components

Parameters

Parameters

Parameters are the attributes that can be used to customize the component when using it in a project. They apply to the WebComponents implementation and wrappers and to the Vue and React CSS implementations. Some parameters names change between the implementations, in order to follow the conventions of each technology and framework.

For example, the param model is named ngModel in Angular, modelValue in Vue, but stays as model in React.

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 params or properties:

Name	Type	Slottable	Description
label	string	✅	Label of the input
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 by using the disabled attribute of the HTML input element.
required	boolean		Marks the input component as required. If and interaction is made with the input and the value is nullable or empty, the input will be marked as invalid as using the invalid attribute.
name	string		Identification for the field inside the form.
help-text	string	✅	The forced message to be shown under the input. It is used to give more information about the input, or a message to the user, specially when the input is invalid.
invalid	boolean		The attribute that forces the state of the input as invalid.
indeterminate	boolean		Marks the component as indeterminate.
custom	object		A record of key-value pairs to set the CSS custom tokens. It's a complex attribute set as an JS object in stringified JSON format. Example: <z-checkbox custom='{"fill":"#06e7a3"}' />
custom-str	string		The stringified version of the custom property. It follows the pattern key:value;key:value;, with the possibility of setting multiple values and spaces between the punctuation characters. Example: <z-checkbox custom-str="fill:#06e7a3" />
z-theme	string		Sets the theme of the component. The possible values are light and dark. <z-checkbox z-theme="dark" />

From Figma to code

You can check the Figma implementation here. This are the available properties:

• Type select
• State select

Customization

INFO

Check everything about the customization mechanics in the "How it works" documentation.

CSS Variable	Type	Description
--z-checkbox--bg	color	Background color
--z-checkbox--border-color	color	Border color
--z-checkbox--label-color	color	Label color

The label color, checkbox color and border color can be customized using the --z-checkbox--label-color, --z-checkbox--bg and --z-checkbox--border-color CSS custom properties, respectively.

Accessibility

...

Related components