Skip to main content

Checklist

A set of checkboxes providing data multi-selection for small datasets.

Form Checkbox Symbol

Configurable properties​

  • Field label: Label displayed on top of the checklist.
  • Field description: Description provided below the checklist.
  • Key: Binds the field to a form variable, see data binding docs.
  • Options source: Checklists can be configured with an options source defining the individual choices your user can make, see options source docs.
  • Disabled: Disables the checklist, for use during development.
  • Hide if: Expression to hide the checklist.
  • Validation: Given that one of the following properties is set, the form will only submit when the respective condition is fulfilled. Otherwise, a validation error will be displayed.
    • Required: Checklist must contain a value.
  • Columns: Space the field will use inside its row. Auto means it will automatically adjust to available space in the row. Read more about the underlying grid layout in the Carbon Grid documentation.

Datatypes​

Checklists can be bound to data of the any[] type, although for most practical cases we recommend string[] instead. The checklist component correlates the bound data with the values of the different options.

The data representation of this checklist:

Checklist Selection Image

Looks like this:

{
  "mailto": [
    "regional-manager",
    "approver"
  ],
}