Properties
The Checkbox Widget properties panel contains settings that control the checkbox label, stored value, validation, and behavior.
General
| Property | Description |
|---|---|
| Label | The text displayed next to the checkbox. |
| Name | Internal field name. Used for data binding and referencing the checkbox in logic or scripts. |
| Value | The value stored in the form data when the checkbox is checked. |
| Default Value | Sets the initial checked state when the form is loaded. |
| Label Placement | Controls the position of the label relative to the checkbox: End (right), Start (left), Top, or Bottom. Default: End. |
| Required | Marks the field as mandatory. Validation fails if the checkbox is unchecked when the form is submitted. |
| Readonly | Prevents the user from changing the checkbox state. |
| Visible | Controls whether the checkbox is displayed. When unchecked, the widget is hidden but remains configured. |
Appearance
| Property | Description |
|---|---|
| Text Align | Controls the horizontal alignment of the checkbox and label within its container. |
| Size | Sets the visual size of the checkbox element. |
Advanced
| Property | Description |
|---|---|
| On Change Handler | When enabled, the widget fires an onChange event to the backend each time the checkbox state changes. The event payload contains widgetName, widgetValue (the stored value when checked, or empty when unchecked), and widgetEvent set to "onChange". |
| Ignore Readonly | Overrides the Readonly setting. Allows the checkbox to remain interactive even if the form or parent container is set to read-only. |