In This Article

About Navigating to Dashboard Pages Built by Wix

Your dashboard extensions can send the Wix user to a dashboard page built by Wix, such as the Wix Blog Posts page or the Order Details page of an order.

How extensions navigate

Code in a dashboard page, a dashboard modal, or a dashboard plugin sends the Wix user to a page by passing a destination object to the navigate() method of the Dashboard API.

A dashboard menu plugin has no code of its own, so it doesn't call navigate(). Its click action can open a page by its page ID.

Destination objects

A destination object holds the page ID of the page to open in its pageId property.

A destination object can also hold a relativeUrl property, a URL segment that navigate() appends to the page's URL. For example, the destination object for the Order Details page of an order holds the order's ID in relativeUrl.

You can get a destination object in either of these ways:

From a page builder: A page builder returns the destination object for its page, with the page ID and any relativeUrl already in it.
From the Page IDs list: You write the destination object yourself, with the page's ID from the Page IDs list in pageId. This works for pages that have no page builder.

Page builders

Page builders are methods that return the destination object for a dashboard page built by Wix.

Each Wix business solution that provides page builders exports them as pages from the dashboard entry point of its package, such as @wix/blog/dashboard.

A page builder for a page about one item, such as orderDetails({ id }), takes the item's ID as a parameter.

The following example passes the destination object that blogPosts() returns to navigate(), which sends the Wix user to the Wix Blog Posts page:

Copy

The page builders are listed below by business solution.

Wix Blog

The following table lists the page builders that @wix/blog/dashboard exports and the destination page of each one:

Builder	Destination page
`blogAnalytics()`	Blog Analytics
`blogCategories()`	Blog Categories
`blogComments()`	Blog Comments
`blogMonetization()`	Blog Monetization
`blogOverview()`	Blog Overview
`blogPosts()`	Blog Posts
`blogSettings()`	Blog Settings
`blogTags()`	Blog Tags
`blogWriters()`	Blog Writers

Wix Bookings

The following table lists the page builders that @wix/bookings/dashboard exports and the destination page of each one:

Builder	Destination page
`exportBookingData()`	Export Booking Data
`serviceForm({ serviceId })`	Service Form, for the service with that ID
`servicesList()`	Services List
`staffEdit({ staffMemberId })`	Staff Edit, for the staff member with that ID
`staffList()`	Staff List
`syncPersonalCalendar()`	Sync Personal Calendar

Wix eCommerce

The following table lists the page builders that @wix/ecom/dashboard exports and the destination page of each one:

Builder	Destination page
`deliveryProfile({ deliveryProfileId })`	Delivery Profile, for the profile with that ID
`deliveryProfiles()`	Delivery Profiles
`editDraftOrder({ draftOrderId })`	Edit Draft Order, for the draft order with that ID
`editOrder({ orderId })`	Edit Order, for the order with that ID
`newOrder()`	New Order
`orderDetails({ id })`	Order Details, for the order with that ID
`orderList()`	Order List
`orderRefund({ orderId })`	Order Refund, for the order with that ID
`taxSettings()`	Tax Settings

Wix Stores

The following table lists the page builders that @wix/stores/dashboard exports and the destination page of each one:

Builder	Destination page
`productsList()`	Products List