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 exampleBy default, if the component returns false, this result will not be added to the output. To add false to the results, specify "preserveFalse": true.
| Name | Type | Description |
|---|---|---|
type* | "field.checkbox-group" | Set component type. |
data* | writable | Data with values that will be processed or changed. Learn more about working with data. |
label | string | Label above the component. |
disabled | boolean | If true, the options are inactive. |
hint | string | 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[].hint | string | Text with additional information about the option. |
options[].label* | string | Text next to the option. |
options[].value* | string | Returned value. |
preserveFalse | boolean | 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. |
validation | condition | Validation based on condition. |
Last updated: May 26, 2023