Checkbox Widget Overview
The Checkbox Widget renders a single toggle checkbox in Buildocs UI Engine. When checked, it stores a configured value in the form data; when unchecked, it stores an empty value.
Behavior
- Displays a checkbox with an optional label
- Stores the configured Value in the form data when checked
- Stores an empty string when unchecked
- Supports a default checked/unchecked state on form load
- Optionally fires an
onChangeevent to the backend when the state changes
Label Placement
The label text can be positioned relative to the checkbox:
| Placement | Description |
|---|---|
| End | Label appears to the right of the checkbox (default) |
| Start | Label appears to the left of the checkbox |
| Top | Label appears above the checkbox |
| Bottom | Label appears below the checkbox |
Adding to a Row
- Open your form in the Form Builder
- Add a Row to the canvas if one is not already in place — see Building Layouts
- Locate the Checkbox widget in the component palette
- Drag the widget into an empty Row segment
- Open the Properties Panel to configure the label, value, and behavior
info
Checkbox widgets must be placed inside a Row segment. They cannot be dropped directly onto the canvas.
Next Steps
- Properties — full reference for all checkbox settings