When you generate a dashboard menu plugin extension, the CLI adds a <your-plugin-name>.extension.ts file to your project that contains the menu plugin builder configuration.
The <your-plugin-name>.extension.ts file contains the dashboard menu plugin builder configuration. You can edit its fields manually to modify its appearance or behavior. However, do not change the extension's id field, as this is auto-generated by Wix and must remain unique across all extensions.
| Field | Type | Description |
|---|---|---|
id | String | Extension's unique identifier. The ID is used to register the menu plugin in the app dashboard and must be unique across all extensions in the project. |
title | String | Text of the menu item the extension adds. |
extends | String | Slot ID into which the extension plugs in. Find the relevant dashboard slot for your app. |
iconKey | String | Icon that appears next to your extension's title. Select a normal-size icon from the Wix Design System and paste its name. |
action | Object | Navigation configuration object that determines the action taken when the extension is clicked. |
action.navigateToPage | Object | Page navigation configuration object. Contains the ID of the target dashboard page. |
action.navigateToPage.pageId | String | ID of the dashboard page to which site administrators are directed. |
action.openModal | Object | Modal navigation configuration object. Contains the ID of the modal page to open. |
action.openModal.componentId | String | ID of the modal to open. |
You can set the dashboard menu plugin action field to either navigate to a dashboard page or open a modal.
Here's an example <your-plugin-name>.extension.ts file: