Add Dashboard Menu Plugin Extensions with the Wix CLI for Headless

Dashboard menu plugin extensions add menu items into pre-configured slots in dashboard pages of apps made by Wix in your headless project. When clicked, it either displays a dashboard modal or directs the project administrator to another dashboard page.

Follow the instructions below to:

1. Create and configure a dashboard menu plugin extension for your project.
2. Build and deploy your project.

Once this task is complete, the dashboard menu you specified in the installation process will contain the item you added, visible only in your project's dashboard.

Before you begin

• You must have a project that was created using the Wix CLI for Headless.
• You must be logged into your Wix Studio workspace. If you don't already have one, sign up for a Wix Studio workspace account.

Step 1 | Create the extension

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

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

Learn more about the dashboard menu plugin extension files.

Step 2 | Customize your dashboard plugin

1. Run the following command to open the dev menu:

   Copy

2. Click the link to open your project's dashboard in the browser, then navigate to the dashboard page hosting your menu plugin.

3. Go to your extension.json file and edit the title to "Hello world!".

1. Save your file.

2. Navigate back to the dashboard page in your browser and see your changes.

Step 3 | Build and deploy your project

Now that your project is ready for production with your new plugin, you can build your project and release your project.

1. Run the following command to build your project:

2. Run the following command and follow the prompts to release a new version:

For more information about building and deploying your project, see Build and Deploy a Project with the Wix CLI for Headless.

Delete a dashboard menu plugin

To delete an existing dashboard menu plugin from your project, delete the subfolder under src/extensions/ that contains your dashboard menu plugin's files.