Within your project, the source code for dashboard modals is located in the src/extensions/
folder. Each modal is defined in its own subdirectory:
The extension.json
file contains the dashboard modal metadata. The structure is as follows:
Field | Type | Description |
---|---|---|
compId | string | The modal ID (GUID) is automatically generated and shouldn't be changed. Must be unique across all extensions in the project. |
compType | string | Always BACK_OFFICE_MODAL for dashboard modals. |
compName | string | The modal name. |
compData.backOfficeModal.hostingPlatform | string | Always BUSINESS_MANAGER . |
compData.backOfficeModal.title | string | The modal title. |
compData.backOfficeModal.width | number | Initial width of the modal in pixels. |
compData.backOfficeModal.height | number | Initial height of the modal in pixels. |
The modal.tsx
file contains the dashboard modal content.
The content is defined as a React component that renders when the modal is active.
Inside a dashboard modal component you may choose to use: