Toggle Field

The Toggle field creates a simple labelled toggle to output boolean values.

Editing UI Widget

This field is displayed as a toggle labelled with the field’s label in the Content Editor. If iconLeft and iconRight are set, they will be displayed on the toggle.

Output Format

The Toggle field outputs either true or false depending on whether the toggle is on or off.

Options

The following options are available for this field (default values shown):

{
  "iconLeft": null,
  "iconRight": null
}

• iconLeft: the name of the icon to display if the toggle is off as a string

• iconRight: the name of the icon to display if the toggle is on as a string

Validation

This field has no validation options.

Version History

• Version at launch: 1