Skip to main content

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 onChange event to the backend when the state changes

Label Placement

The label text can be positioned relative to the checkbox:

PlacementDescription
EndLabel appears to the right of the checkbox (default)
StartLabel appears to the left of the checkbox
TopLabel appears above the checkbox
BottomLabel appears below the checkbox

Adding to a Row

  1. Open your form in the Form Builder
  2. Add a Row to the canvas if one is not already in place — see Building Layouts
  3. Locate the Checkbox widget in the component palette
  4. Drag the widget into an empty Row segment
  5. 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