Toggle

The toggle item is for capturing a logical value. The toggle has three states: selected, not selected and undefined. The undefined state is when the user has not made a choice yet. Only selected and not selected states can be chosen.

This field can be an alternative to a yes/no Single Choice question.

Preview

The toggle field widget.

Design

Definition

The standard properties apply:

Property	Definition
Type	The type of item (see above).
Name	The name of the item is not visible. It is a “variable” name that will be associated to the data collected. You will refer to this variable name when writing condition and/or validation scripts.
Label	The label is usually a question or a title.
Description	The description gives some guidance about how to enter data, what are their meaning etc.
Required	Whether an input is mandatory. Note that this does not apply when the visibility Condition is not satisfied.

The following dynamic properties apply:

Property	Definition
Condition	The condition makes an item visible or not, depending of other data. It is a small script which returns a logical value: true when item is visible. When no condition is specified (which is the default), the item is visible. See How to make fields conditional?
Validation	The validation specifies whether the data entry is correct. It is a small script which returns a logical value: true when item value is valid. Note that this validation script is not evaluated when the visibility Condition is not satisfied. See How to validate field values?
Validation error message	The validation error message to be displayed when validation fails.

Settings

Property	Definition
Default	The default value: either true or false.

Style

Property	Definition
Label class	CSS class to apply to the field label. See How to style a form item?