For the managed package runtime, toggle element properties are configurable in the Property Panel when you select a Toggle element in the Flexcard Designer. Trigger an action when a user selects a Toggle element.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
Beginning Winter '22, access the Toggle element from the Inputs section of the Build panel. Before Winter '22, access the Toggle element from the Elements section of the Build panel.
Common Toggle Element Properties
These properties are shared by all Toggle element types.
|
Property |
Description |
Reference |
|---|---|---|
|
Add Action |
Add an action that gets triggered when a user clicks the toggle element. |
|
|
Conditions |
Add a condition that must be met for the element to display. |
|
|
Element Name |
The name of the element as seen on the canvas. Used to distinguish one element from another as you build your Flexcard in the designer. Is used only within the designer. |
|
|
Extra Class |
Enter a class appended to the container of the element. Select from a class defined in the Add Custom CSS feature of the Flexcard Designer or any style sheet available to the Flexcard. |
n/a |
|
Toggle Type |
Set the type of toggle element to display. |
Toggle Element Properties
|
Property |
Description |
Type |
|---|---|---|
|
Alignment |
Select whether to align each checkbox horizontally or vertically. |
Checkbox Group |
|
Alternative Text |
Enter text for accessibility, visible when image isn’t present. |
Stateful Icon |
|
Checked Icon Name |
Select the icon visible when the element is checked. |
Checkbox Button, Dual Stateful Button, Stateful Button |
|
Checked Label |
Select the label visible when the element is checked. |
Stateful Button, Dual Stateful Button, Checkbox Toggle |
|
Checked |
Set the toggle element to be checked by default. |
Stateful Icon, Checkbox Button, Checkbox Toggle, Stateful Button, Dual Stateful Button |
|
Disabled |
Disable the toggle element. Or disable the toggle element based on the value of a data field whose value returns true or false. The field must have a boolean value. If the value returns a string, Disabled is false. |
Stateful Icon, Checkbox Button, Checkbox Toggle, Stateful Button, Dual Stateful Button |
|
Help Text |
Add text visible when user hovers over the help |
Stateful Icon, Checkbox Button, Checkbox Group Button, Checkbox Group, Checkbox Toggle |
|
Icon Name |
Select the icon. |
Stateful Icon |
|
Icon On Hover |
Select the icon visible on hover of the element. |
Stateful Button |
|
Label On Hover |
Select the label visible on hover of the element. |
Stateful Button |
|
Label |
Enter a visible label for the element. |
Stateful Icon, Checkbox Button, Checkbox Group Button, Checkbox Group, Checkbox Toggle |
|
Options |
Enter a key/value pair for each checkbox option. |
Checkbox Group, Checkbox Group Button |
|
Required Label |
Add text next to the asterisk when Require is enabled. |
Stateful Icon, Checkbox Button, Checkbox Group Button, Checkbox Group, Checkbox Toggle |
|
Required |
Make the toggle element a required field. Adds an asterisk next to the element. |
Checkbox Toggle, Checkbox Group Button, Checkbox Group |
|
Unchecked Icon Name |
Select the icon visible when the element is unchecked |
Checkbox Button, Dual Stateful Button, Stateful Button |
|
Unchecked Label |
Select the label visible when the element is unchecked. |
Stateful Button, Dual Stateful Button, Checkbox Toggle |
|
Field Binding |
Updates the data source with the value of the selected state of the toggle element. |
Stateful Icon, Checkbox Button, Checkbox Toggle, Stateful Button, Dual Stateful Button |
|
Value |
Add default value. For example, set a value as true or enter a comma-separated list of selected options. |
Checkbox Group, Checkbox Group Button |
|
Variant |
Select from predefined SLDS styles to change the appearance of the element. |
Stateful Button |