switchTab

Switches the tab on a tabView to the provided index.

note

The first tab of a tabView starts with the number 0.

Field Configurations

Key	Type	Description	Default Value
"params" (required)	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"index" (required)	Number,String	Index of the tab to navigate to. Starting at 0.	null
"navigateToRoot"	Boolean,String	Specifies whether to navigate to the lowest view in the tab.	null
"navigateToRootAnimated"	Boolean,String	Specifies if an animation should be used.	false
"onSuccess"	String	Event that will be fired in case of success.	null
"onSuccessType"	String	Type of the onSuccess event	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: Switch to specific tabs

Show ExampleHide Example

Switch to the corresponding tab with the index specified in the params.

{
  "type": "switchTab",
  "params": {
    "index": 0
  }
}

{
  "type": "switchTab",
  "params": {
    "index": 1
  }
}

{
  "type": "switchTab",
  "params": {
    "index": 2
  }
}