---
title: "checkbox · RUAL Documentation"
description: "Generates a basic checkbox. The field will be used as state key, prefixed with the form."
canonical: https://docs.rual.nl/block-types/state%20ui/state_input_checkbox
language: en
---

# checkbox

This block is part of the [`state ui`](https://docs.rual.nl/block-types/state%20ui) group and was last modified in core [`v13.0.6`](https://docs.rual.nl/core-versions/130006).

### Field Selection Required

This block relies on a field that you select to perform its data actions. You must manually select the field you want to use in your flow using the field selector modal. To access the modal, click the white button on the block.

Generates a basic checkbox. The field will be used as state key, prefixed with the `form`.

- form id required `value` A unique ID for the form this field is used in.

- value required `value` An optional value that will be toggled inside the array field.

- class `uiclass` Assigns a CSS class to the element. • Hidden when unused

- style `uistyle` Applies inline CSS style to the element • Hidden when unused

- attributes `uiattributes` Adds custom attributes to the element. • Hidden when unused

- state `state` Returns the element to the frontend state.

A typical wiring for [checkbox](https://docs.rual.nl/block-types/state%2520ui/state_input_checkbox): [value](https://docs.rual.nl/block-types/value/value_default) feeds the `form_id` pin; [value](https://docs.rual.nl/block-types/value/value_default) feeds the `value` pin; the `state` out pin feeds [get component child](https://docs.rual.nl/block-types/state%2520actions/state_component_get_child).

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

### Version history

Introduced in [`v13.0.1`](https://docs.rual.nl/core-versions/130001).

Last modified in [`v13.0.6`](https://docs.rual.nl/core-versions/130006).

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

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