Checkbox
The Checkbox component can be used in any form to provide a set of checkboxes.
Examples
Checkbox group with multiple selection enabled.
Form Data:
{}Field Properties
Properties used by this field (inside meta field in schema)
| Name | Description | Type |
|---|---|---|
| name | The unique identifier for the checkbox control instance. | string |
| displayName | A string that sets the display name of the checkbox control. | string |
| displayType | A string indicating the type of control, which is "checkbox" in this case. | string |
| description | A string providing additional information or instructions about the checkbox control. | string |
| value | The initial value of the selected checkboxes. | array |
| options | An array of objects representing the checkbox options. Each object should contain: | array of objects |
| label | The display label for the checkbox (within options). | string |
| value | The value of the checkbox (within options). | any |
| validation | An object for validation rules. | object |
| required | A boolean indicating if the checkbox control is required (within validation). | boolean |
| readOnly | A readonly field is not editable and value cannot be changed | boolean |
| config | An object that configures advanced properties. | object |
Config Object
Key: config
| Key | Description | Type |
|---|---|---|
| multiple | Allow users to select multiple options | boolean |