In This Article
navigate
Navigates the user to another page in the dashboard.
If an invalid pageId
value is passed to this function, a "Page Not Found" page will be displayed in the dashboard.
Signature
Copy
1(destination: Destination) => void
Parameters
Name | Type | Description |
---|---|---|
destination | Destination | Destination to navigate to. |
Destination Object
Copy
1{2 pageId: string;3 relativeUrl?: string;4}
Name | Type | Description |
---|---|---|
pageId | string | ID of the page to navigate to. Use the Page IDs table 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. |
Examples
To set up a dashboard client, refer to the setup guide.
Navigate to the dashboard's homepage
Copy
1client.dashboard.navigate({pageId: 'home'});
Navigate to your own app's page with some internal state
Copy
1client.dashboard.navigate({pageId: <your-page-id>, relativeUrl: "/an/internal/state?param=value"})
Was this helpful?
Yes
No