Skip to main content

Checkbox

The checkbox field allows users to select one or more predefined options. It is useful for multiple-choice inputs or binary decisions.

Example

fields:
  interests:
    label: Interests
    type: checkbox
    options:
      interest_a: Interest A
      interest_b: Interest B

Field Properties

Name Type Default Description
aria string –

Optional aria label for better accessibility.
autofocus bool false

Set autofocus on field.
error string | array –

Costum error message for translation or customization.
help string | array –

Optional help text below the field
label string | array –

The field label can be set as string or associative array with translations
options array –

Defines the available choices for the checkbox field as key-value pairs. Each key must be unique, and the values can be multilingual.
placeholder string | array –

Optional placeholder value that will be shown when the field is empty.
required bool –

Defines whether the field is mandatory for form submission.
title string | array –

Tooltip displayed when the user hovers over the field (supports multilingual configurations).
width string 1/1

The width of the field in the 12 columns field grid.