Introduction

Dashboard plugin extensions allow you to create interactive and feature-rich widgets that seamlessly integrate into pre-defined slots on Wix business solution dashboard pages.

There are 2 types of plugins that can be added to a dashboard page:

• Dashboard plugin: A widget that can be embedded inside a dashboard page slot to extend the page's functionality.
• Dashboard menu plugin: A widget that can be embedded inside a slot in a dashboard page menu. Clicking on the widget opens a modal or directs you to another dashboard page.

Learn more about dashboard plugin extensions.

Get started

You can implement dashboard plugins with the following frameworks:

• Wix CLI: Learn how to implement a dashboard plugin with the Wix CLI.
• Self-hosted: Learn how to implement a self-hosted dashboard plugin.

You can implement dashboard menu plugins with the following frameworks:

• Wix CLI: Learn how to implement a dashboard menu plugin with the Wix CLI.
• App dashboard: Learn how to implement a dashboard menu plugin in the App Dashboard.

Slots

Slots are containers in the UI for plugins.

To enable plugins to interact with their host environment, each slot supports an API that provides contextual data to the plugin. The method for retrieving contextual data depends on the framework used to build your app:

• Wix CLI: Use the React component's props to retrieve the parameters passed by the plugin.
• Self-hosting: Use observeState() to retrieve the parameters passed by the plugin.

The contextual data can be retrieved by different components for dashboard plugins and dashboard menu plugins:

• Dashboard plugins: The code for the dashboard plugin can retrieve the contextual data.
• Dashboard menu plugins: The code for the modal or page opened by the dashboard menu plugin can retrieve the contextual data.