Button

Click to copy

Look and Feel Settings

  • Label (not mandatory) to be used to show the component's label.
  • Icon (not mandatory) - button icon.
  • Size (mandatory) - standard button sizes.
  • Type (mandatory) - standard button layouts.
  • Name (mandatory) - this name will help you find this component in BP.
  • Enabled (mandatory) - availability of the button in the application. Is turned on by default.
  • Visible () - makes the component visible if turned on. Enabled by default.

Workflow triggers:

  • 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:

Button Get Properties:

Gets the button's properties 

Input parameters:

  • Component Id [string] - button component's identifier.

Output parameters:

  • Label [string] - button's label;
  • Type [enum] - button's type;
  • Size [enum] - button's type;
  • Icon [enum] - button's icon;
  • Color [string] - button's color;
  • Visible [boolean] - button's visibility state;
  • Enabled [boolean] - button's enabled/disabled state;
  • Loading [boolean] - button's loading state. 

Button Get Properties

Button Set Properties

Sets all button's properties

Input parameters:

  • Component Id [string] - button component's identifier.
  • Label [string] - button's label;
  • Type [enum] - button's type;
  • Size [enum] - button's type;
  • Icon [enum] - button's icon;
  • Color [string] - button's color;
  • Visible [boolean] - button's visibility state;
  • Enabled [boolean] - button's enabled/disabled state;
  • Loading [boolean] - button's loading state. 

Button Set Properties

Button Update Properties

Update the button's properties

Input parameters:

  • Component Id [string] - button component's identifier.
  • Label [string] - button's label;
  • Type [enum] - button's type;
  • Size [enum] - button's type;
  • Icon [enum] - button's icon;
  • Color [string] - button's color;
  • Visible [boolean] - button's visibility state;
  • Enabled [boolean] - button's enabled/disabled state;
  • Loading [boolean] - button's loading state.

Button Update Properties

Button Click

Performs a button click

Input parameters:

  • Component Id [string] - button component's identifier.

Button_onClick

Button Reset State

Resets all button states to default

Input parameters:

  • Component Id [string] - button component's identifier.

 Button Reset State

Button Set Loading

Sets the loading state to true

Input parameters:

  • Component Id [string] - button component's identifier.

 Button Set Loading

Button Remove Loading

Sets the loading state to false Input parameters:

Input parameters:

  • Component Id [string] - button component's identifier.

 Button Remove Loading
 

Button Enable

Sets the enabled state to true

Input parameters:

  • Component Id [string] - button component's identifier.
     Button Enable

Button Disable

Sets the enabled state to false

Input parameters:

  • Component Id [string] - button component's identifier.
     
     Button Disable

Button Show

Sets the visible state to true

Input parameters:

  • Component Id [string] - button component's identifier.


 
 Button Show

Button Hide

Sets the visible state to false

Input parameters:

  • Component Id [string] - button component's identifier.

Button Hide
 


Usage example:

For example, using a button to open a modal window

Example Button