field.checkbox-group

Adds a group of checkboxes for selecting independent answer options. This is useful if there are several options. You can add just one checkbox, but it's easier to use field.checkbox for that.

View example in the sandbox.

Component properties

NameTypeDescription
type*"field.checkbox-group"

Set component type

data*writable

Data with values that will be processed or changed.

labelstring

Label above the component.

disabledboolean

If `true', the options are inactive.

hintstring

Hint text.

options*array

An array of checkboxes, where value is the value to change, and label is the text near the checkbox.

options[]object

A checkbox.

options[].hintstring

Text with additional information about the option.

options[].label*string

Text next to the option.

options[].value*string

Returned value.

preserveFalseboolean

Property that specifies whether to return false values in the results. By default, if the component returns false, this result will not be added to the output. To add false to the results, specify "preserveFalse": true.

validationcondition

Validation based on condition.

NameTypeDescription
type*"field.checkbox-group"

Set component type

data*writable

Data with values that will be processed or changed.

labelstring

Label above the component.

disabledboolean

If `true', the options are inactive.

hintstring

Hint text.

options*array

An array of checkboxes, where value is the value to change, and label is the text near the checkbox.

options[]object

A checkbox.

options[].hintstring

Text with additional information about the option.

options[].label*string

Text next to the option.

options[].value*string

Returned value.

preserveFalseboolean

Property that specifies whether to return false values in the results. By default, if the component returns false, this result will not be added to the output. To add false to the results, specify "preserveFalse": true.

validationcondition

Validation based on condition.