Dashboard Pages

A dashboard page occupies a full page in the Wix dashboard. Unlike modals, plugins, and menu items, which extend or attach to existing pages, a dashboard page is a new standalone destination.

Pages can be placed in the dashboard navigation or hidden and reached programmatically.

Like all dashboard extensions, dashboard pages don't appear on the live site. Only Wix users with the required permissions can see them.

When to use a dashboard page

Use a dashboard page when you need significant screen space and a self-contained workflow. Common cases include:

• Rendering site or business data for monitoring and analysis, like a sales summary with charts and exports.
• Configuring app or site behavior, like notification or email preferences.
• Integrating data or services hosted outside Wix, like a shipping carrier rate lookup.
• Providing a multi-view interface under a single page using SPA-style internal routing.

For lighter or more contextual interactions, choose another dashboard extension type.

Page code

Use the Dashboard SDK at runtime to read host context, navigate between dashboard locations, and open modals. Call other Wix APIs from inside the dashboard to read and write site data, including the business solution APIs.

When you're writing the UI in React, prefer the Wix Design System and Patterns. They're React component libraries that match the native Wix dashboard look.

Authentication and permissions

Dashboard page code runs with the identity of the Wix user viewing it, the site owner or a collaborator who's logged into the dashboard.

What the page can do is bounded 2 ways:

• The Wix user's role on the site determines which methods they're allowed to invoke.
• When the page belongs to an installed app, the app declares the permission scopes the page needs in its manifest, and those scopes further constrain what the page can call.

For some restricted methods, you can elevate the call from backend code to gain higher authorization than the current user has.

Dashboard pages across development paths

The development path determines how you build a dashboard page:

• Sites: Build dashboard pages through the Wix Editor or Wix Studio. See Add a Dashboard Page in Extend Websites.
• Wix-managed headless projects:
  • Full Wix integration (Astro): Use the Wix CLI. See Add Dashboard Page Extensions with the Wix CLI.
  • Other frameworks: Don't support dashboard page extensions directly. Follow the same approach as self-managed headless projects.
• Self-managed headless projects: Don't add dashboard extensions directly. Instead, you create a private app that registers the extension and install that app in your headless project.
• Wix-managed apps: Use the Wix CLI. See Add Dashboard Page Extensions.
• Self-managed apps: Build the page on infrastructure you manage. The dashboard embeds it as an iframe whose source URL you provide. See Add Self-Hosted Dashboard Page Extensions in Build Apps.
• Blocks apps: Build the page in the Wix Blocks visual editor. See About Dashboard Pages in Blocks in Build Apps.