Create a Dashboard Page Component

3 min read
·
Last updated on Jul 10, 2023
You can create a back-office dashboard page component to help users manage their business or website. There are two ways to do this:
  1. Integrate with the Wix Dashboard (recommended)
  2. Link to your external website from the Wix Dashboard
Where it appears
This component appears as a page in the sidebar of the Wix Dashboard, and doesn't appear to site members on your live site. All users in your account with the relevant permissions to view third-party apps can see your app in the Wix Dashboard. This includes owners, contributors, and more.

Create a Wix dashboard component

Creating your app page directly in the Wix Dashboard (versus linking to your external website) gives users a seamless experience and allows you to use our Dashboard SDK to interact with the Wix Dashboard. This creates an entry point for your app in the side menu of a user's site dashboard.
  1. Go to your app's page in the Wix Developers Center.
  2. Click Components in the side menu (under Build Your App).
  3. Click Add Component > Dashboard component.
  4. Select Dashboard Page.
  5. Click Add Component.
  6. Add a Name (this is only visible to you).
  7. The Component ID is auto-generated once you click Save. Use this identifier later with the Dashboard SDK to trigger navigation between your app’s pages.
  1. Add a valid iFrame URL to display your app as an iFrame embedded in the dashboard. The App Instance query parameter is attached to the dashboard URL so that you can identify and automatically log users in when they open your dashboard.
  2. Add a Relative route – provide a URL suffix that will be appended when users visit your page in the Dashboard. E.g., https://manage.wix.com/dashboard/site_identifier_guid/app/app_identifier_guid/relative_route_used
  3. Choose whether to hide the Wix side menu when your page is open.
  1. Add a Page name. This will be shown to your app users in their Wix site's back office.
  1. Click Save.
  2. Users of your app will now see an entry for your app in the side menu of their site dashboard.

Add and organize multiple Wix dashboard pages

You can create multiple dashboard pages for different experiences within your app. E.g., an overview page and a settings page.

In this case, all of your dashboard pages will be bundled under a top side menu entry under your app’s name, and all your dashboard's pages will appear when a user hovers or clicks on it.
  1. Add additional pages following the steps above.
  2. Click the Manage icon on any of your dashboard pages.
  1. Choose the order you'd like your pages to appear in the user's side menu. Your main page will be your app's name, followed by sub-sections as shown below.
  1. Click Save.

Create an external dashboard page

This means a user will open your app in Manage Apps and a new tab will open with your own URL, outside of the Wix platform. If you choose to link out to an external URL, then you need to follow these steps.
  1. Go to your app's page in the Wix Developers Center.
  2. Click Components in the side menu (under Build Your App).
  3. Click Add Component > Dashboard component.
  4. Select External URL.
  5. Add your Page URL. The App Instance query parameter is attached to the dashboard URL so that you can identify and automatically log users in when they open your dashboard.
  1. Click Save.
Important
Apps that have a dashboard page with an external URL won't appear in the side menu of the Wix Developers Center.
IN THIS ARTICLE
Previous article
Next article

Related Content

Developers Center Setup

Translate Your App Listing

You can increase your app’s reach by speaking to users in their own language. One way to do this is to translate your market listing info to help users better understand your app's features and benefits. You ca
3 min read

General

About App Components

There are two main types of component: website and dashboard. All apps must have at least one component, but you can have two or more.You can find the Components tab in the Wix Developers Center. This is where

3 min read

Embedded Scripts

Set Up an Embedded Script Component

Setting up an embedded script app in the Wix Developers Center enables you to insert custom script tags to the <head> tag of your users' websites.Here's what you'll need to do:Add an embedded script component

6 min read

Iframes

Deep Linking for Internal Dashboard Components (iframe)

Important:We're currently having issues with this feature and are working hard to fix it. If you experience problems with deep linking then you can contact us.An internal Dashboard component supports deep linki
2 min read

Iframes

Internal Dashboard Component Guidelines

In this article, we’ll review some general guidelines that we recommend for your dashboard component, so that your app feels native to the Wix platform.Tip:We recommend checking out the App Installation Flow, i
3 min read