---
title: "checkbox · RUAL Documentation"
description: "Basic HTML checkbox element"
canonical: https://docs.rual.nl/block-types/Component%20UI/component_checkbox
language: en
---

[Cluster](https://docs.rual.nl/cluster)

[Blocks](https://docs.rual.nl/block-types)

[Interfaces](https://docs.rual.nl/interfaces)

[Blueprints](https://docs.rual.nl/blueprints)

[Tutorials](https://docs.rual.nl/tutorials)

[Home automation](https://docs.rual.nl/home-automation)

[Examples](https://docs.rual.nl/examples)

[Reference](https://docs.rual.nl/reference)

[Architecture](https://docs.rual.nl/architecture)

[Troubleshooting](https://docs.rual.nl/troubleshooting)

Other

# checkbox

This block is part of the [`Component UI`](https://docs.rual.nl/block-types/Component%20UI) group and was last modified in core [`v11.3.0`](https://docs.rual.nl/core-versions/110300).

Basic HTML checkbox element

- Field required `fielddefinitions` Field to save the value in

- Validate `fieldvalidation` Applies the given validation to the element, overwrites attributes given in the attributes popup

- Event `inputevent`

- In Array `condition` This needs to be set to true if the field is an array and the given value should be pushed into that array

- Value `value` Used in combination with the in array in pin. If given will push the value into the array. If not given, true and false will be used.

- uicomponent `uicomponent`

A typical wiring for [checkbox](https://docs.rual.nl/block-types/Component%2520UI/component_checkbox): [combine](https://docs.rual.nl/block-types/fields/fielddefinitions_multiple) feeds the `co-fields` pin; the `uicomponent` out pin feeds [build PDF](https://docs.rual.nl/block-types/files/file_generate_pdf).

[![Studio canvas example for the checkbox block: typical wiring for checkbox.](https://docs.rual.nl/canvas-examples/component_checkbox.png)](https://docs.rual.nl/canvas-examples/component_checkbox.png?v=3)

## Version history

Introduced in [`v11.3.0`](https://docs.rual.nl/core-versions/110300).

- [Back to `Component UI`](https://docs.rual.nl/block-types/Component%20UI): Return to the main group to view all sub-groups

- [Back to `form`](https://docs.rual.nl/block-types/Component%20UI?group=form): Return to the group to view all blocks within this group

Was this page helpful? [Tell us what to improve](https://docs.rual.nl/support) · RUAL Docs is an integral component of the [RUAL ecosystem](https://rual.nl)