When you add a dashboard page extension, the generated files land under src/extensions/dashboard/pages/<page-route>/ and the extension is registered in your project's extensions.ts.
This file set is the same whether you add the page in a Studio Two site project or in a Wix CLI project.
| File | What it's for |
|---|---|
<page-route>.extension.ts | The configuration file for the page ID, title, route, and component path. |
<page-route>.tsx | The page content: the React component that renders when the page is active. |
The <page-route>.extension.ts file declares the page with extensions.dashboardPage().
Import extensions from the package your project uses:
Example:
| Field | Type | Description |
|---|---|---|
id | string | Page ID as a GUID. Used to register the page, and as the pageId you pass to navigate(). It must be unique across all dashboard pages in the project. When the page belongs to an app, this ID is also how the page is registered in the app dashboard. |
title | string | The page title. Used as the browser tab title, and as the dashboard sidebar label if the page appears in the sidebar. |
routePath | string | Route that leads to this page. Appended to the dashboard base URL. |
component | string | Path to the page content component. |
priority | number | Optional. Order of this page in the dashboard sidebar when the project has multiple dashboard pages. Smaller numbers appear higher in the list. |
fullPage | boolean | Optional. Whether the dashboard sidebar is hidden while the page is open. Default: false. |
metaData | object | Optional. How the page appears in dashboard search. See Dashboard search with metaData. |
Use metaData to control how the page appears when Wix users search the dashboard. Dashboard search lists the page only when searchable is true and it has a description.
When you generate a dashboard page, the CLI adds metaData with searchable: true and a default description. Replace the default description with a description of what Wix users can do on the page.
| Field | Type | Description |
|---|---|---|
searchable | boolean | Whether the page appears in dashboard search results. Set to false for pages that only work when opened from another page, such as a details or edit page. |
description | string | Description of the page for dashboard search. Required when searchable is true. Maximum: 200 characters. |
title | string | The page name in dashboard search. Dashboard search doesn't index the page title, so set this field to the same value to make the page findable by its name. |
Dashboard search matches the words Wix users type against metaData.title and metaData.description. Use the words Wix users type when looking for the page.
For example, for a project with a Reports page:
For a page that only works when opened from another page, set searchable to false:
Note: The CLI build doesn't check metaData value limits, such as the description length. Values outside the limits are rejected when you release the project.
The <page-route>.tsx file exports a React component that renders when the page is active.
Inside a dashboard page component you can use:
Last updated: 2 November 2026