Modules
Display conditions

Rate this page:

Compass admin page

The compass:adminPage module adds a configuration page that is accessible by navigating to Apps, then clicking Configure for the app. Content is then rendered on a new Compass page that is accessible to Compass administrators only. You can use the UI kit or custom UI to create content for the page.

Properties

PropertyTypeRequiredDescription
key

string

Yes

A key for the module, which other modules can refer to. Must be unique within the manifest.

Regex: ^[a-zA-Z0-9_-]+$

functionstringThe admin 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 admin page.
resourcestringA reference to the static resources entry that your admin page wants to display. See resources for more details.
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.
titlestringYesThe title of the admin page, which is displayed at the top of the page.
iconstringThe URL of the icon that's displayed next to the title. A generic app icon is displayed if no icon is provided.

Extension context

Custom UI

PropertyTypeDescription
typestringThe type of the module (compass:adminPage)
urlstringThe URL of the admin page.

UI kit

PropertyTypeDescription
typestringThe type of the module (compass:adminPage)
urlstringThe URL of the admin page.

Rate this page: