Configure switch field

The switch field configures a boolean on/off control that represents a true or false state. The displayed labels for each state can be customized or replaced with icons when no text is provided.

Business use cases

Switch fields support clear representation of binary states in forms and lists. Key scenarios include:

  • Feature toggling: Enable or disable functionality using a clear on/off control.

  • Status indication: Represent active vs. inactive states in a compact form.

  • UI simplification: Use icons instead of text to reduce visual noise where labels are unnecessary.

Procedure

  1. In the Application tree, select the field that should represent an on/off state.

  2. In the Settings/properties pane, set the field type to Switch.

    Result: The field is rendered as a toggle switch. The 'On' Text and 'Off' Text fields appear.

  3. In 'On' Text, enter the label to display when the switch is in the true or enabled state.

    • The default label is On.

    • Text is truncated if it exceeds the available spece.

    • If a single spacebar press is entered, no text is shown and an icon is displayed instead.

    Example: Enter Enabled.

    Result: The switch displays Enabled when turned on.

  4. In 'Off' Text, enter the label to display when the switch is in the false or disabled state.

    • The default label is Off.

    • Text is truncated if it exceeds the available spece.

    • If a single space character is entered, no text is shown and an icon is displayed instead.

    Example: Enter Disabled.

    Result: The switch displays Enabled when turned off.

  5. (Optional) Use icons instead of text by replacing the context of both 'On' Text and 'Off' Text with a single spacebar press.

    Result: The switch displays icons that indicate the on and off states.

  6. In the Shell bar, select Save.

  7. In the Preview pane, confirm that the switch toggles correctly between on and off states and that the configured text or icons are displayed as expected.

Result

  • You have configured a switch field with customized on and off state representation using text or icons.