In your project, the configuration files for dashboard menu plugins are located in the src/extensions/ folder. Each menu plugin is defined in its own subdirectory. Each subdirectory contains one file, extension.json, that has the plugin configuration details.
The extension.json file contains the dashboard menu plugin configuration details. You can edit some its fields manually to modify its appearance or behavior. The structure is as follows:
| Field | Type | Description |
|---|---|---|
compId | String | Extension's unique identifier. The ID is used to register the menu plugin and must be unique across all extensions in the project. |
compType | String | Always BACK_OFFICE_EXTENSION_MENU_ITEM for dashboard menu plugins. |
compName | String | Name of the menu plugin. |
compData.backOfficeExtensionMenuItem.hostingPlatform | String | Always BUSINESS_MANAGER. |
compData.backOfficeExtensionMenuItem.title | String | Text of the menu item the extension adds. |
compData.backOfficeExtensionMenuItem.iconKey | String | Icon that appears next to your extension's title. |
compData.backOfficeExtensionMenuItem.extends | String | Slot ID into which the extension plugs in. |
compData.backOfficeExtensionMenuItem.action | Object | Navigation configuration object that determines the action taken when the extension is clicked. Possible values are either openModal or navigateToPage. |
compData.backOfficeExtensionMenuItem.action.openModal | Object | Dashboard modal configuration object. Contains the ID of the dashboard modal to display when the extension's menu item is clicked, along with additional parameters. |
compData.backOfficeExtensionMenuItem.action.openModal.componentId | String | ID of the dashboard modal to display when the extension's menu item is clicked. |
compData.backOfficeExtensionMenuItem.action.openModal.componentParams | Object | Additional configuration parameters you can pass to the dashboard modal. |
compData.backOfficeExtensionMenuItem.action.navigateToPage | Object | Page navigation configuration object. Contains the ID of the target dashboard page, as well as additional configuration parameters. |
compData.backOfficeExtensionMenuItem.action.navigateToPage.pageId | String | ID of the dashboard page to which site administrators are directed. |
compData.backOfficeExtensionMenuItem.action.navigateToPage.relativeUrl | String | URI segment appended to the base URI of the target dashboard page. |
Here's an example extension.json file: