Dashboard extensions let you add UI and functionality to the site dashboard, where Wix users manage their site, business, and content. Your custom dashboard extensions render alongside native Wix pages and tools, and are visible only to Wix users with the required permissions.
The implementation and support for dashboard extensions differ across Wix development paths, such as extending websites or building apps. Before you start, check your development path and project type to understand which functionality is available to you.
Wix provides several extensions. Learn how to choose an extension type for the functionality you intend to build.
This reference documents the files, code, and configuration needed to add a dashboard extension to a Wix CLI project or a Studio Two site. Depending on the extension type, you may need to set up one or more of the following:
This reference documents the files your project generates when you add a dashboard extension. The files and where they go depend on the extension type. For example, a dashboard page has a configuration file that declares the extension and a component file that contains your UI.
This reference documents the code you implement in the extension files, which covers the following:
UI: What Wix users see and interact with, such as pages, modals, and widgets. Use the Wix Design System and Patterns so your extension matches the native dashboard look.
Functionality: What the extension does in the dashboard. Use the Dashboard API, which Wix built for dashboard extensions, to interact with the dashboard around your extension. For example, you can read context from the host, navigate between dashboard locations, open modals, and show toasts. Use Wix APIs to read and write site data.
This reference documents the dashboard pages built by Wix that your extensions work with: the page IDs and page builders that send the Wix user to a page, and the slots that plugins and menu plugins fill. See About Dashboard Pages Built by Wix.
This reference documents the identity your code runs as and the permissions it needs. Depending on the project type and extension, you may need to consider the following:
Identity: The Wix user who's logged in to the dashboard, whose identity your code runs as.
Permissions: The Wix user's role and, for apps, the permission scopes your app declares, which together decide whether a call works.
Elevation: Backend code that elevates a call for restricted methods that need more authorization than the Wix user has.