The Checkbox Group field type displays a group of related checkboxes, allowing users to toggle multiple boolean options within a single field.
Overview
The Checkbox Group field type (checkboxGroup) presents a collection of related checkboxes within a single field. Each checkbox in the group can be independently toggled on or off, allowing users to select multiple options from a set of related choices.
Properties
| Property | Required | Description |
|---|
| ID | Yes | The field identifier. |
| Type | Yes | Must be set to checkboxGroup |
| Name | Yes | The display label for the group. |
| Options | Yes | An array of checkbox options. Each has an ID and display text. |
| Width | No | The percentage width. |
| Help | No | Tooltip text. |
| Visibility | No | A condition controlling visibility. |
Checkbox Group vs. Multi Select vs. Individual Checkboxes
| Feature | Checkbox Group | Multi Select | Individual Checkboxes |
|---|
| Display | All options visible at once as checkboxes | Dropdown, options hidden until clicked | Separate fields scattered across the form |
| Selection | Toggle any combination | Select from dropdown | Toggle each independently |
| Best for | Small, related sets where all options should be visible | Larger option lists | Unrelated boolean fields |
Use Cases
- Feature flags — enabling/disabling multiple features for a record
- Compliance checks — ticking off compliance requirements
- Notification preferences — selecting which notifications to receive
- Applicable categories — marking which categories apply to the record
Best Practices
- Use Checkbox Group for small sets of related options (typically 3 to 8 items)
- For larger option sets, use Multi Select to save screen space
- Set the width to at least 50% to give the checkboxes adequate display room
- Group all related options under a single Checkbox Group rather than creating multiple individual checkbox fields