Dashboard Menu Plugin Extension Files and Code

In This Article

In your app project, the configuration files for dashboard menu plugins are located in the src/dashboard/menu-plugins folder.

Each menu plugin is defined in its own subfolder with the name you provided during the installation process. Each subfolder contains one file, plugin.json, that has the plugin configuration details.

Extension configuration metadata (plugin.json)

The plugin.json file contains the dashboard menu plugin configuration details. You can edit its field manually to modify its appearance or behavior. However, do not change the extension's id field, as this is auto-generated by Wix and must remain unique across all extensions.

Field	Type	Description
id	String	Extension's unique identifier. The ID is used to register the page in the Wix Dev Center and must be unique across all extensions in the app.
title	String	Text of the menu item the extension adds.
subtitle	String	Secondary text that appears in the menu just below the title.
iconKey	String	Icon that appears next to your extension's title. Select a normal-size icon from the Wix Design System and paste its name.
extends	String	Slot ID into which the extension plugs in. Find the relevant dashboard slot for your app.
action	Object	Navigation configuration object that determines the action taken when the extension is clicked. Possible values are either `openModal` or `navigateToPage`.
action.openModal	Object	Dashboard modal configuration object. Contains the ID of the dashboard modal to display when the extension's menu item is clicked, along with additional parameters.
action.openModal.componentId	String	ID of the dashboard modal to display when the extension's menu item is clicked.
action.openModal.componentParams	Object	Additional configuration parameters you can pass to the dashboard modal.
action.navigateToPage	Object	Page navigation configuration object. Contains the ID of the target dashboard page, as well as additional configuration parameters.
action.navigateToPage.pageId	String	ID of the dashboard page to which site administrators are directed.
action.navigateToPage.relativeUrl	String	URI segment appended to the base URI of the target dashboard page. It can include path segments, search parameters, and hash information.

Here's an example plugin.json file:

Copy

1{
2  "id": "e357ba12-da11-4bb3-b5db-45921fcb36e4",
3  "title": "Activity Statistics",
4  "subtitle": "Show a graph of recent activity",
5  "iconKey": "Activity",
6  "extends": "084a82b9-c9a5-4bb0-bf82-e071f2f79d2a",
7  "action": {
8  // One of:
9    "openModal": {
10      "componentId": "9157ba1d-da11-4bb3-a5db-45911fcb36e5",
11      "componentParams": {
12        "origin": "calendar-page"
13      }
14    },
15    "navigateToPage": {
16      "pageId": "e357ba12-da11-4bb3-b5db-45921fcb36e4",
17      "relativeUrl": "?origin=import-modal"
18    }
19  }
20}

Was this helpful?

Yes