Table of Contents

Checkbox

Live demo

Renders a boolean input field.

Node name : checkbox

Attributes

Bound

Attribute Type Required Default value Description
property-name string true UI view property name
item UI view false @DatasourceCurrent Item to be bound to

Unbound

Attribute Type Required Default value Description
value string true Input value.
label string false Input label.
disabled bool false false Value indicating whether the input is disabled
required bool false false Value indicating whether the input is required.
message-text string false Additional message displayed next to the component. Usually a warning or an error message.
message-severity string (information, warning, error) false Severity of the additional message displayed next to the component.
documentation string false Documentation
tab-stop bool false true Value indicating whether the input can be focused using the Tab key.
value-changed string false Name of the method called when the value has changed. The first parameter is the value and the second is the current item of the data source (DatasourceCurrent) or the iterated item in a repeat component.

Common

Attribute Type Required Default value Description
label-position string (top, left, right, hidden) false top Label position
message-position string (bottom, hidden) false bottom Message position
focused bool false false Value indicating whether the component is focused.
display-mode string (switch, checkbox, vertical-radio, horizontal-radio) false switch Display mode
true-label string false Yes True value label
false-label string false No False value label
null-label string false Undefined Null value label

Example

Bound

<checkbox property-name="Enable" />

Unbound

<checkbox value="@Fields.Value" label="myLabel" disabled="true" required="true" />