About Dashboard Menu Plugin Extensions

The dashboard menu plugin extension integrates with apps built by Wix, such as Wix Bookings, to enhance their functionality. The extension adds an item into a pre-configured slot in the menu of a dashboard page added by the app. When a site administrator clicks the added menu item, it directs them to a different dashboard page or displays a dashboard modal.

Since menu plugin extensions are added to dashboard pages, they do not appear on the live site, so site visitors never see them. They are, however, visible to site admins with the required permissions.

About Plugin Slots

Some apps built by Wix contain slots in one or more of dashboard pages. Slots are UI placeholders that can be populated with plugin extensions, such as the dashboard menu plugin or the generic dashboard plugin. When building a plugin extension, you need to specify the ID of the slot where you want your plugin to be placed.

For instance, if a user has the Wix Bookings app installed on their site, your app can add a menu item to the More Actions menu in the Calendar dashboard page. When clicked, your app can display a dashboard modal that summarizes the total hours booked in the current week, or allows the site administrator to manage their staff schedule without having to leave the calendar page.

Apps built by Wix also determine the data from the dashboard page that is passed through the slot for you to utilize in the functionality of your plugin, such as an ID. The parameters that are passed are slot-specific and some slots don't pass any parameters. You can retrieve dashboard page data using the withDashboard() function from the dashboard-react SDK or the observeState() function from the dashboard SDK.

Note:

When to use the dashboard menu plugin extension

Use the dashboard menu plugin extension when you want to add a menu item that directs the user to another dashboard page or opens a dashboard modal. You can create functionality such as:

  • Directing the user to another dashboard page that's part of your app, with additional parameters such as path and search parameters.
  • Directing the user to another dashboard page that's part of a Wix business solution, such as Wix Stores or Wix Blog.
  • Changing service settings without having to leave the current dashboard page.

Implementation options

To configure the dashboard menu plugin extension, you can use either the Wix Dev Center or the Wix CLI.

See also

Was this helpful?
Yes
No