closeView

Closes a previously created, named view.

note

The view does not have to be on top of the viewstack or be visible to the user at this point. The action looks for a view with the specified name and closes it.

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
"name" (required)	String	The name of the view to be closed.	null
"transition"	Boolean,String	Specifies whether the system animation should be used.	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: Close a view

Show ExampleHide Example

The name param specifies the view that is to be closed.

{
  "type": "closeView",
  "params": {
    "name": "view_closeViewExampleMenuRight"
  }
}