Checkboxes

Type key: checkbox_choice. Renders a list of options with a checkbox or radio control in front of each one. Respondents pick one option, or several when select_options_selection is multiple. In the editor this is the Checkboxes block.

A question with options: the question rules and option rules apply, and it can sit in a layout row column.

Meta fields

The meta fields of this node type are listed in the request body of Replace the draft document, under pages › nodes, in the checkbox_choice tab.

Example

A minimal Checkboxes node

{
  "public_id": "nDie",
  "sort_order": 1,
  "type": "checkbox_choice",
  "meta": {
    "question": "<span>Dietary needs</span>",
    "select_options_data": [
      {
        "value": "vegetarian",
        "label": "Vegetarian"
      },
      {
        "value": "vegan",
        "label": "Vegan"
      },
      {
        "value": "gluten_free",
        "label": "Gluten-free"
      }
    ],
    "validation": {
      "required": false
    }
  }
}

Defaults and rules

• The defaults are select_options_selection: "single", select_options_style: "checkbox" (radio is the alternative), and select_options_randomize: false.
• default_value is one option value, or an array of values when select_options_selection is multiple.