Switch

Click to copy

Look and Feel Settings:

Label(not mandatory) to be used to show the component's label.

Name(mandatory) - this name will help you find this component in BP.

Size(mandatory) - standard switch sizes.

Default checked(mandatory) - turn on by default.

Disabled (mandatory) - availability of the switch in the application. Is turned on by default.

Visible(mandatory) - makes the component visible if turned on. Enabled by default.


Workflow triggers:

  • onChange– fires when a change occurs in the field;
  • onBlur– fires when the field is deselected;
  • onFocus– fires when a field is selected (clicked on);
  • onCreate– fires when the element is created on the page;
  • onShow– fires when the component changes its state to visible (displayed on the page);
  • onHide– fires when the component changes its state to hidden (stops being displayed);
  • onDestroy– fires when the component is destroyed;
  • onClick- fires when the component is clicked.

Component Actions:

Switch Get Properties

Gets switch properties

Input parameters:

Component Id [string] - switch component's identifier.

Output parameters:

  • Label[string] - component's label;
  • Placeholder[string] - component's placeholder;
  • Disable[boolean] - disables component if true;
  • Visible [boolean] - component visibility state.
  • Tooltip [string] - tooltip string;
  • Required Mark [boolean] - shows required mark if true;
  • Debounce (ms) [integer] - delay to validate the value;
  • Validate Icon [boolean] - icon to be showed on validate the value;
  • Validate Status [Status type] - status to be showed on validate the value;
  • Validate Message [string] - message to be showed on validate the value.

Switch Set Properties

Sets all switch properties

Input parameters:

  • Component Id [string] - switch component's identifier;
  • Label[string] - component's label;
  • Placeholder[string] - component's placeholder;
  • Disable[boolean] - disables component if true;
  • Visible[boolean] - component visibility state.
  • Tooltip[string] - tooltip string;
  • Required Mark [boolean] - shows required mark if true;
  • Debounce (ms) [integer] - delay to validate the value;
  • Validate Icon[boolean] - icon to be showed on validate the value;
  • Validate Status [Status type] - status to be showed on validate the value;
  • Validate Message [string] - message to be showed on validate the value.

Switch Update Properties

Update switch properties

Input parameters:

  • Component Id [string] - switch component's identifier;
  • Label[string] - component's label;
  • Placeholder[string] - component's placeholder;
  • Disable[boolean] - disables component if true;
  • Visible[boolean] - component visibility state.
  • Tooltip [string] - tooltip string;
  • Required Mark[boolean] - shows required mark if true;
  • Debounce (ms) [integer] - delay to validate the value;
  • Validate Icon [boolean] - icon to be showed on validate the value;
  • Validate Status [Status type] - status to be showed on validate the value;
  • Validate Message [string] - message to be showed on validate the value.


Usage example:

Switch can be used to publish existing posts

Switch | AppMaster Docs