Rate this page:
Compass global page
The compass:globalPage module adds a page to Compass that is accessible by clicking on the Apps dropdown, then clicking on the page name. Content is then rendered on a new Compass page
that is accessible to all Compass users.
You can use the UI kit or custom UI to create content for the page.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
key |
| Yes |
A key for the module, which other modules can refer to. Must be unique within the manifest. Regex: |
function | string | The global page module requires a function for use with the UI kit or a resource when building with custom UI. | A reference to the function module that defines the global page. |
resource | string | A reference to the static resources entry that your global page wants to display. See resources for more details. | |
render | 'native' | Yes for UI Kit 2 | Indicates if the module is a UI Kit 2 module. |
resolver | { function: string } | Contains a function property, which references the function module that defines the configuration of resource. Can only be set if the module is using the resource property. | |
title | string | Yes | The title of the global page, which is displayed at the top of the page. |
icon | string |
The icon displayed next to the For custom UI and UI kit apps, the If no icon is provided, or if there's an issue preventing the icon from loading, a generic app icon will be displayed. |
Extension context
Custom UI
| Property | Type | Description |
|---|---|---|
type | string | The type of the module (compass:globalPage) |
UI kit
| Property | Type | Description |
|---|---|---|
type | string | The type of the module (compass:globalPage) |
UI kit 2
This module now has support for UI Kit 2 (preview) for faster user experiences and to access additional React features.
For more information on all the supported modules, see the Supported products and their modules section.
Rate this page: