Add Dashboard Menu Plugin Extensions with the Wix CLI

Dashboard menu plugin extensions add menu items into pre-configured slots in dashboard pages of apps made by Wix in your 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. Customize your dashboard menu plugin.

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

Step 1 | Create the extension

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

Upon completion, the extension files will be created in your project directory with the following structure:

Copy

Note: This is the default folder structure created by the CLI. You can move these files to any location within the src/ folder and update the references in your extension.ts file. Learn more about the flexible file system.

Learn more about the dashboard menu plugin extension files.

Step 2 | Customize your dashboard plugin

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

  2. Click the link to open the dashboard in the browser. Navigate to the dashboard page hosting your menu plugin.

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

Copy
  1. Save your file.

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

Build and deploy your project

Once your project is ready for production, you can build and deploy it.

Delete a dashboard menu plugin

To delete an existing dashboard menu plugin from your project:

  1. Delete the folder that contains your dashboard menu plugin extension's file.
  2. Remove the import and .use() statements for the extension from the extensions.ts file.

Important:

If you've already released a version of your project, you must build and deploy the project again after removing the dashboard menu plugin file.

See also

Did this help?