Add a Dashboard Plugin Extension in Studio Two

A dashboard plugin is a custom widget that fills a predefined slot on a dashboard page built by Wix.

Follow the instructions below to:

1. Add a dashboard plugin extension to your site project.
2. Customize the plugin.
3. Check the plugin in the dashboard.
4. Publish your site with the plugin.

Step 1 | Add a dashboard plugin

To add a dashboard plugin:

1. In the Studio Two editor, open the Code tab.

2. In the VS Code sidebar, open the Wix Extension Builder.

   

3. Under Create an Extension, choose Dashboard, then Dashboard Plugin.

4. Fill in the form:

   • What would you like to extend?: Choose the slot from the dropdown, for example Products Page. The dropdown lists slots from Wix business solutions regardless of whether they're installed on your site. For the pages that have slots and where each slot appears, see About Dashboard Page Slots.
   • Plugin Title: The display title for the plugin.

5. Click Generate.

Generate names the plugin folder after the title, in lowercase with hyphens.

You can find the new files under src/extensions/dashboard/plugins/<plugin-folder>/. The extension is registered in your project's extensions.ts and listed under My Extensions. For what each file is for, see Dashboard Plugin Extension Files and Code.

Check that extends in <plugin-folder>.extension.ts is the ID of the slot you chose. The dropdown's labels can differ from the slot names in the docs, so compare extends with the slot ID in the page's introduction. For example, Products Page is the Wix Stores Products banner slot, 3ca518a6-8ae7-45aa-8cb9-afb3da945081.

Step 2 | Customize your dashboard plugin

You can edit the generated files to match the look and behavior you need. Change the code yourself, or ask the AI in the Code tab to help. When you're happy with the plugin, move on to the next step.

For the full workflow, from reading the data the slot passes to calling Wix APIs, see Build a Dashboard Plugin in Studio Two.

For example, to update the card title:

1. Open <plugin-folder>.tsx.
2. Change the Card.Header title from "Dashboard Plugin" to "Hello world!".
3. Save the file.

When you view the plugin in its dashboard slot, the card title shows Hello world!.

Step 3 | Check the plugin

A dashboard plugin renders inside a slot that belongs to a specific Wix business solution's dashboard page, so you need that app installed before you can check it. For example, for Products Page, install Wix Stores. You don't need to publish the site to check the plugin.

To check the plugin:

1. In the site dashboard, open that app's host page, for example Catalog > Store Products > Products.
2. Refresh the page so the dashboard loads the plugin. The plugin renders where the host page defines the slot, with the card title you set in Step 2. For Products Page, that's above the product table.

If the plugin doesn't appear, or appears empty, wait a moment and refresh the page again.

Step 4 | Publish your site

When you're ready, click Publish in the Studio Two editor to ship the extension with your site.

See also

• About Dashboard Plugins
• Build a Dashboard Plugin in Studio Two
• Dashboard Plugin Extension Files and Code
• About Studio Two Extensions
• Dashboard Plugins