Overview
The Checkbox field type (checkbox) provides a simple toggle control for capturing boolean (yes/no, true/false) values. It renders as a clickable checkbox that users can toggle on or off.
Properties
| Property | Required | Description |
|---|---|---|
| ID | Yes | The field identifier. |
| Type | Yes | Must be set to checkbox |
| Name | Yes | The display label shown next to the checkbox. |
| Width | No | The percentage width within the form section. |
| Read Only | No | When true, the checkbox is displayed but cannot be toggled. |
| Help | No | Tooltip text for the field label. |
| Grid | No | When true, appears as a column in list views, typically showing a tick or cross icon. |
| Default | No | The default state for new records (checked or unchecked). |
| Visibility | No | A condition controlling when this field is visible. |
Checkbox as a Visibility Trigger
Checkboxes are frequently used as the trigger for visibility conditions on other fields, rows, or panels. For example, a checkbox labelled "Include Financial Details" could control the visibility of an entire financial form section. When checked, the financial fields appear; when unchecked, they are hidden.
Use Cases
- Feature toggles — enabling or disabling a feature for the record (e.g. "Active", "Published")
- Confirmations — acknowledging a condition (e.g. "Terms Accepted", "Data Verified")
- Flags — marking a record with a boolean attribute (e.g. "Priority", "Archived", "Confidential")
- Visibility controls — showing or hiding other sections based on checkbox state
Best Practices
- Use clear, descriptive labels that make the meaning of checked vs. unchecked obvious
- Consider using a 50% or smaller width, since checkboxes are compact and do not need full-width display
- For more than two options, use an Indexed Select instead of multiple checkboxes
- Use the Checkbox Group field type when you need multiple related checkboxes together