About Dashboard Plugins

A dashboard plugin is a widget that renders in a slot on a dashboard page built by Wix, such as the eCommerce Order page. In Studio Two you add one from the Code tab through the Wix Extension Builder, so you can show your own data and actions on the business solution pages the site uses.

For when to use a plugin versus a page or a modal, and for identity, permissions, and the APIs you call from the plugin, see Dashboard Plugins.

Anatomy of a dashboard plugin

A dashboard plugin in a Studio Two project is a configuration file and the React code that implements it:

• The plugin code is the React component that renders in the slot.
• The configuration file declares the plugin's ID, title, slot, and component path. For the full set of fields, see Dashboard Plugin Extension Files and Code.

You generate the files first, then edit the React component to match the look and behavior you need. For that workflow end to end, see Build a Dashboard Plugin in Studio Two.

How dashboard plugins are used

• You add the plugin from the Code tab through the Wix Extension Builder, which puts its files in your site project and registers it.
• You choose the slot the plugin fills. Each slot belongs to a page of a Wix business solution, such as Wix Bookings or Wix eCommerce, so the plugin appears only on a site where that business solution is installed.
• When a Wix user opens the host page, the slot passes data from the page to the plugin, such as the ID of the order in view. From the plugin you can call the Dashboard SDK and other Wix APIs.

See also

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