Toggle Button control

Basic control to choose state as True or False.

A Toggle button control is used when the user has to choose between an ON and OFF state. When the state of the button is On, the value this control passes is TRUE and if the state is Off, the value is set to FALSE . For example, a user can select the features they want in their application by using a toggle button.

toggle button control

Properties

UI properties

  • Label : Label is the text that is displayed above the toggle switch and helps the user to understand what they are supposed to input in the toggle switch.

  • Properties : These properties help you customize the Label by changing the text size, weight ( Light, Normal, Bold, Extra Bold, X Extra Bold), alignment (Left, Center, Right, Justified) and color of the label.

  • Type : The Type field is automatically generated depending upon the type of control used. In this case, it is a “Toggle_Button” type.

  • Unique Name : A Unique Name is used to uniquely identify a control in your App. Every control that is added on the screen gets an auto-generated Unique Name on the basis of the Label name given to the control.

  • Tooltip: This allows you to add the Tooltip text that would provide a hint to the user for providing input. The Tooltip icon would be visible if you switch on the Show tooltip icon toggle property available below.

  • Description: Is the description that you can add for your controls. The Description would only be visible if you switch on the Show Description toggle property available below.

  • Submit Data : This field lets you determine whether to send the value of the control or not in Workflow based on various control states. There are three conditions that could be set for this field.

    1. Always : When this condition is selected, the data in the toggle field will be submitted irrespective of the state of the toggle field.

    2. Never : When this condition is selected, the data in the toggle field will never be submitted irrespective of the state of the toggle field.

    3. No When Hidden : When this condition is selected, the data in the toggle field will be submitted if the toggle field is visible and not submitted when the toggle field is hidden .

  • Required : When you select the required option, the field becomes a mandatory field and the user can not submit without filling it.

  • Read Only : When you select this option, the user will no longer be able to edit this field.

  • Show Tooltip Icon: This allows you to toggle switch ON or OFF to show or hide the tooltip icon where the tooltip text would appear.

  • Show Description: This allows you to toggle switch ON or OFF to show or hide the Description text.

  • Hidden : The hidden option helps you to hide the field from the user. This might help to perform some computation you don’t want the user to see or if you want to show certain fields only when a specific condition is met/not met.

  • Caching : When the caching option is selected and if a LOOKUP formula is applied to this control, the state that the LOOKUP returns will be cached and the user will be able to see this state even when he accesses the microapp later with no connectivity. This option is required when you want your app to be accessible in offline mode as well and getting the latest data from the sheets always is not critical.

  • Hide Label : This option hides the label of the toggle field from the toggle switch.

  • Trigger dependents: When you Disable Trigger Dependents, it helps you to reduce or optimize the unnecessary evaluation of the dependent control’s formula. For a detailed explanation refer to this article here .
    By default, Trigger dependents is enabled. However, in complex apps by switching it off, you would limit the evaluation in the dependent control and in turn ensure quicker response times.

Style

toggle properties

  • Theme : The theme lets you choose the color of the text box. You can either enter a custom hex code value or use one from the available themes in the builder.

How to Use a Toggle Button control?

Start with selecting the Toggle Button control from the Basic section of the Controls Menu.

rich text editor control1

The Toggle Button will then appear on the screen in the builder, you can then set all the above properties as per your requirements.

You can use the Data option to bind data to the Toggle Button.

There are different ways in which you can bind data.

Bind Data

  1. Static Data: This is the data that does not change over the period of time. Such data is used to assign default values in fields in your application. The static data can be based on the data type i.e. Numeric, Text, and List type data.

  2. Sheets: This allows you to fetch data from a sheet and display it in the fields. Select your sheet from the list and then select the columns to be used. You can also add filters and sort data.

  3. Controls: This allows you to get data from one of the App controls.

  4. Variables: This assigns the value of the variables defined in the app.

  5. LoggedIn User: You can display the properties related to the LoggedIn User like username, usermail, Admin, status, and so on. You can select a single property only. Select column and click Save.

  6. API: This allows you to add an API and select the values returned by the respective API. You can select multiple keys to display values in the detail view.

  7. Custom Formula: This can be used to apply formulas and store the output of those formulas in the detail view rows. You can learn more about formulas here.

Preview

False State

image

True State

image