In This Article

Add Dashboard Page Extensions with the CLI

Wix Apps can extend the Wix Dashboard by adding new pages to the dashboard. You can create a dashboard page to help users manage their sites or businesses. Dashboard pages aren’t part of a live site, so site visitors never see them.

The Wix CLI makes it easy to create and develop dashboard page extensions, and to manage dashboard pages in the sidebar.

For general information about this extension type, read About Dashboard Page Extensions

Follow the instructions below to:

Create a dashboard page extension for a Wix CLI app.
Customize your dashboard page.
Build and deploy your app.

Once this task is complete, your app will have a dashboard page extension that adds a new dashboard page to a user's site.

Before you begin

You must have an app project that was created using the Wix CLI.
You must be logged into your Wix Developer account. If you don’t have one, sign up for a Wix Developer account.

Step 1 | Create the extension

Run the following command and follow the prompts to create a dashboard page extension:

Copy

Enter the route for your page. The route is the path that is appended to the dashboard base URL to access the dashboard page. For more information, see Page Routes.

The extension files will be created in your local app files under the chosen route with the following structure:

Copy

For more information about these files, see Dashboard Page Extension Files and Code.

Step 2 | Customize your dashboard page

Run the following command to open the dev menu:
Copy
1
Press D to view a list of dashboard pages, then select the number corresponding to your new dashboard page's route name. This will open a browser window previewing your dashboard page.

Note that the subtitle on the page is "Edit src/dashboard/pages/test-route-2/page.tsx to change this text."

Leave this window open.
Go to your dashboard page's page.tsx file and change subtitle in Page.Content to "Hello world!":
Copy
1
Save your file.
Navigate back to your browser and check that the subtitle on the page is now "Hello World!".

Step 3 | Build and deploy your app

Now that your app is ready for production, you can build your app and create a version of it in the Wix Dev Center.

Run the following command to build your app:

Copy

Run the following command and follow the prompts to create an app version:

Copy

An app version allows you to publish an app to the Wix App Market or install it on a site with a direct install URL.

For more information about building and deploying your app, see Build and Deploy an App with the CLI.

Delete a dashboard page

To delete an existing dashboard page from your app, delete the subfolder under src/dashboard/pages that contains your dashboard page's files.

Note: If you've already created a version of your app, deleting a dashboard page's files from your project will not remove the registration of the dashboard page from the Wix Developers Center. To remove the registration, create a new version after deleting the dashboard page's files.

Templates and Tutorials

The following CLI app templates with dashboard pages are available:

Custom Products Catalog - Add or remove products via a dashboard page using Wix Stores APIs.
Mixpanel Analytics - Embed Mixpanel's tracking code directly into the DOMs of sites.