Add Dashboard Menu Plugin Extensions with the CLI

A dashboard menu plugin is an app extension that adds a menu item into a pre-configured slot in a dashboard page of an app made by Wix. When clicked, it either displays a dashboard modal or directs the site administrator to another dashboard page.

Create a dashboard menu plugin extension with the CLI

Follow the instructions below to:

1. Create and configure a dashboard extension for a Wix CLI app.
2. Build and deploy your app.

Once this task is complete, the dashboard menu you specified in the installation process will contain the item you added.

Before you begin

• You must have an app project that was created using the Wix CLI.
• You must be logged into your Wix Developer Center account. If you don’t already have one, sign up for a Wix Developer Center account.
• Your site must already have installed the app you wish to extend.

Step 1 | Create the extension

In your project directory, run the following command and follow the prompts to create a dashboard menu plugin extension:

1
npm run generate

When the process is completed, you can find the extension files in the local app folder with the following structure:

1
src
2
└── dashboard
3
    └── menu-plugins
4
        └── <your-menu-plugin-folder-name>
5
            └── plugin.json

Learn more about the dashboard menu plugin extension file.

Step 2 | Build and deploy your app

To make the extension available to your users, you must build your app and create a new version in the Wix Dev Center. An app version allows you to publish an app to the Wix App Market or install it on a site with a direct installation URL.

1. Run the following command to build your app:

1
npm run build

1. Run the following command and follow the prompts to create an app version on the Dev Center:

1
npm run create-version

For more information about building and deploying your app, see Build and Deploy an App with the CLI.

Delete a dashboard menu plugin

To delete an existing dashboard menu plugin from your app, navigate to src/dashboard/menu-plugins in your project's directory, and delete the subfolder that contains your dashboard menu plugin's configuration file.

Templates and Tutorials

Check out the following resources to learn more about using this extension:

• Add Dashboard Menu Plugins Extensions with the CLI.