Checkbox Field Element
A multi-option checkbox form control.
The Checkbox Element displays a group of <input type="checkbox"> HTML elements wrapped in a <label>, use it to allow users choosing, by toggling boxes, a single or multiple pre-established options.
Settings
It inherits common settings with the following specifics:
| Setting | Description |
|---|---|
| Layout | The layout that will be used to display the options, Vertical or Horizontal. |
Common Settings
| Setting | Description | Dynamic |
|---|---|---|
| Label | The title for the field that represents the field data. | ✓ |
| Control | The name that identifies the field control within the form. It's required and must be unique for the Form Area. | |
| Value | The efault value for the field. The user can change it. | ✓ |
| Readonly | Should the field be read-only. Any default value will be unedible. | |
| Autofocus | Should the field will be autofocused as soon as the page loads. Only one field can be focused on each page. | |
| Sync ID / Control | Should the field ID attribute obtain it value from the Control Name. |
Options
Options are specified as child items that can be input manually as well as dynamically with the use of a Dynamic Content source. Each option has the following settings:
| Setting | Description |
|---|---|
| Value | The option value, must be a unique among its siblings. |
| Text | The option text, defaults to the value if omitted. HTML tags are supported. |
| State | Defines if the option is Disabled or Enabled. Disabled options are unusable and unclickable. |
| Id | The option ID attribute, overrides any ID set in the parent element. |
Validation
It inherits common validation with the following specifics:
| Validation | Description | Dynamic | Browser Side | Server Side |
|---|---|---|---|---|
| Min | The minimum amount of options that must be chosen, greater than or equal to. | ✓ | ✓ | |
| Max | The maximum amount of options that can be chosen, lower than or equal to. | ✓ | ✓ |
Common Validation
| Validation | Description | Dynamic | Browser Side | Server Side |
|---|---|---|---|---|
| Required | Defines if the field must have a value. | ✓ | ✓ | ✓ |
| Error Message | A message that will be displayed if the element validation fails. Optionally use {fieldlabel} as placeholder, it will be replaced with the field label. | ✓ | ✓ |
Integration
- Access a Builder layout and create a Form Area.
- Add a Checkbox Element from the Form Essentials group.
- Access the element settings and input a Control Name.