Checkboxes Field

Checkboxes allowing the user to select one or more options from a named list.

Preview

Which colours do you like?

Option 1

Option 2

Option 3

JSON definition

{
  "type": "CheckboxesField",
  "name": "fieldName",
  "title": "Question title",
  "hint": "",
  "list": "",
  "shortDescription": "",
  "options": {},
  "schema": {}
}

Properties

Property	Type	Required	Description
`hint`	`string`	No	Hint text displayed below the field label to help the user answer the question.
`list`	`string`	Yes	Name of a list definition that provides the options to display. See list schema for the list definition format.
`shortDescription`	`string`	No	A short description of the field used in the check-your-answers summary.

Options

Property	Type	Required	Description
`bold`	`boolean`	No	When `true`, displays option labels in bold.
`classes`	`string`	No	Additional CSS classes applied to the component.
`condition`	`string`	No	Name of a condition that controls whether this component is shown.
`customValidationMessages`	`object`	No	A map of Joi error codes to custom error messages.
`instructionText`	`string`	No	Alternative text read by screen readers in place of the field title.
`optionalText`	`boolean`	No	When `true`, appends '(optional)' to the field label.
`required`	`boolean`	No	Whether the field must be filled in. Defaults to `true`.
`type`	`string`	No	Display style for the list: `'bulleted'` or `'numbered'`.

Schema constraints

Property	Type	Description
`max`	`number`	Maximum value, character length, word count, or file count.
`min`	`number`	Minimum value, character length, word count, or file count.
`length`	`number`	Exact character length required.