navigate()
Navigates the user to another page in the dashboard.
To identify a page to navigate to you can:
- Look up it's page ID.
- Use a builder method to generate the destination object for a particular page. Several SDK modules include builder methods for the pages relevant to each module. For example,
bookings,blog, andecomall provide builder methods.
If you specify an invalid page ID when you call this function, the Wix user will see "Page Not Found" in their dashboard.
Note: Currently, you can't call navigate() to navigate to pages built when developing sites or building apps with Blocks.
You can specify how to display the page you're navigating to using the displayMode option.
There are two display modes available:
- Main display mode: The browser replaces the current main page content with the new page.
- Overlay display mode: The new page is displayed in a modal overlay on top of the main page.
Learn more about dashboard page navigation.
Method Declaration
Copy
Parameters
| Name | Type | Description |
|---|---|---|
destination | Destination | Destination page to navigate to. |
options | NavigationOptions | Optional. Options for the navigation. |
Destination Object
Copy
| Name | Type | Description |
|---|---|---|
pageId | string | ID of the page to navigate to. See Page IDs to find the appropriate ID. |
relativeUrl | string | Optional. URL segment to append to the base URL of the selected page. Can include path segments, a query string, and a fragment identifier. |
NavigationOptions Object
Copy
| Name | Type | Description |
|---|---|---|
displayMode | "main" | "overlay" | "auto" | When using main, the browser replaces the current main page content with the new page. When using overlay, the new page is displayed in a modal overlaid on top of the main page."auto" (default) causes the page to be loaded in the current context. This means if navigate() is called from the main page, the main page changes. If it's called from an overlay page, the overlay content changes to the new page. |
history | "push" | "replace" | Optional. Determines whether the URL of the page being navigated to is added to the browser's session history, or replaces the URL in the current entry. |
Examples
Note: To call this method in self-hosted apps, you need to create a client. See the setup guide for more details.
Navigate to the dashboard's homepage
Copy
Navigate to your own app's page with some internal state
Copy
Navigate to a relative route of the current page
Copy
Open bookings settings page in an overlay page
Copy
Navigate to the home page as a main page from inside an overlay page
Copy
Did this help?