Navigation API
This is the POS UI Extension API for navigating between screens.
NavigationApiContent
Anchor link to section titled "NavigationApiContent"| Name | Type | Description |
|---|---|---|
| currentModal | Modal |
Contains the information about the currently presented modal |
| Name | Type | Description |
|---|---|---|
| path | string |
Used to determine which Screen or Navigator to return for the Modal extension point |
| params | any? |
Used when presenting a modal to pass any initial parameters or attach callbacks |
Navigation actions
Anchor link to section titled "Navigation actions"Navigate to a route in current navigation tree
Anchor link to section titled "Navigate to a route in current navigation tree"Navigates to the specified screen. It is important to note that any screens you wish to navigate to must already exist in the Navigator.
| Name | Type | Description |
|---|---|---|
| screenName | string |
The name of the screen you want to navigate to |
| params | any? |
The parameters you want to pass to that screen |
Pops the currently shown screen
Anchor link to section titled "Pops the currently shown screen"
Dismisses the modal
Anchor link to section titled "Dismisses the modal"