Checkboxes Field × Mattrbld

The Checkboxes field allows selecting multiple values from a set of values.

Editing UI Widget

This field is displayed as a set of checkboxes labelled with the field’s label in the Content Editor.

Output Format

The Checkboxes field outputs the selected values as an array of these values in their predefined types.

Options

The following options are available for this field (default values shown):

{
  "type": 'inline',
  "checkboxes": []
}

type: how to display the checkboxes, may be one of the following:
- inline: display the checkboxes next to each other, wrapping to a new line if there is not enough space
- wide: display each checkbox on its own line, filling the entire available width
checkboxes: the options available in the Checkbox field. May be either an array of values, an array of { label, value } objects, or an object containing a path to a JSON file and a key to look an options array up under

Validation

The following validation options are available for this field (default values shown):

{
  "enforceMinMax": false,
  "max": null,
  "min": null,
  "unit": "selected"
}

Notes

If you only want users to be able to select a single value, you may be looking for the Dropdown and Radio Group fields.

If you configure the field to pull options from a file by providing a path to a JSON file and a key in options.checkboxes, make sure that the value of that key is an array of non-object values like numbers or strings, or an array of { label, value } objects. JSON-files consisting of a single array are currently unsupported. The value of label is what will be displayed to the user, while the value of value is what will be stored when the checkbox is clicked.

Version History