showLoadingOverlay

Field Configurations

Key	Type	Description	Default Value
"params"	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"maxTime"	Number,String	Time in seconds after which the overlay is hidden at the latest. If nothing is specified, the overlay remains as shown.	null

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: Create a showLoadingOverlay action

Goal: Display a loading overlay that is going to be hidden in 5 seconds.

maxTime key has to be assigned within the params object of the action.

{
  "type": "showLoadingOverlay",
  "params": {
    "maxTime": 5
  }
}

Result:

A showLoadingOverlay action that will display a loading overlay for 5 seconds has been created.