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

Step 1 | Create the extension

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

Copy

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

Copy

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 app dashboard. 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:
Copy
  1. Run the following command and follow the prompts to create a new app version in the app dashboard:
Copy

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.

Note: If you've already created a version of your app, deleting the dashboard menu plugin's files from your project does not remove the registration of the extension from your app's latest version in the app dashboard. To remove the registration, create a new version after deleting the dashboard menu plugin's configuration file.

Templates and Tutorials

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

See also

Did this help?