Skip to main content
Version: 8.3

"Checkbox" type field

Level: beginner

"Checkbox" type field is a field type to select either of the two values: "true" or "false." "true" value is a selected checkbox. Learn more: Fields, Set up a Checkbox field (user documentation).

Properties

string id

The unique ID. Service field.


boolean value

Whether to hide the checkbox status. By default, "false."


boolean disabled

Whether to lock the checkbox from editing. By default, "false."


boolean inversed

Whether to invert the checkbox style. By default, "false."


string label

The checkbox title.


string ariaLabel

The checkbox property mapped to the aria-label element attribute. Learn more about the aria-label attribute: official vendor documentation (Mozilla).


string labelPosition

Specify where to display the checkbox title. By default, "auto."

Available values

auto

Move the checkbox title automatically when the available screen space for the input changes. By default, to the left. When shrunk, above.

left

Display the title to the left of the checkbox.

right

Display the title to the right of the checkbox.

hidden

Hide the checkbox title.

above

Display the title above the checkbox.


Events

boolean valueChange

Whether to fire when the checkbox value changes.


See also

Overview of Freedom UI Designer and its elements (user documentation)

Set up a Checkbox field (user documentation)