Dashboard Sidebar Category Extension Files and Code

When you add a dashboard sidebar category extension, the generated file lands under src/extensions/dashboard/sidebar-categories/<category-folder>/ and the extension is registered in your project's extensions.ts.

This file is the same in a Wix CLI app and in a Wix-managed headless project.

Copy
FileWhat it's for
<category-folder>.extension.tsThe configuration file for the sidebar category ID, title, and priority. It also exports the category ID for dashboard pages to import.

A sidebar category has no component file. Dashboard pages link to it through their own configuration. See Pages in a sidebar category.

Configuration file

The <category-folder>.extension.ts file declares the sidebar category with extensions.dashboardSidebarCategory() and exports the category ID as APP_SIDEBAR_CATEGORY_ID.

Import extensions from the package your project uses:

Copy
Copy
Copy

Example:

Copy

Configuration fields

FieldTypeDescription
idstringSidebar category ID as a GUID. The generated file sets it to APP_SIDEBAR_CATEGORY_ID, which dashboard pages import to link to the category.
titlestringThe label of the category in the dashboard sidebar. The generated file uses the title you enter when you generate the extension.
prioritynumberOptional. Order of the category in the dashboard sidebar. The app's sidebar categories and its pages that aren't in a category are ordered together. Smaller numbers appear higher. Default: 0.

Pages in a sidebar category

A dashboard page is in a sidebar category when its configuration sets pageCategoryId to the category's id. The file that the CLI generates for a dashboard page doesn't set pageCategoryId.

The following example shows a page's .extension.ts file that imports APP_SIDEBAR_CATEGORY_ID from the category's file and sets pageCategoryId:

Copy

The pages in a sidebar category are ordered by their own priority. If a page's pageCategoryId doesn't match a sidebar category, the page doesn't appear in the dashboard sidebar. In a Wix-managed headless project, it appears under Custom Pages instead. For the other page fields, see Dashboard Page Extension Files and Code.

See also

Last updated: 19 November 2026

Did this help?