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

Property	Type	Required	Description
`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_-]+$`
`function`	`string`	The 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.
`resource`	`string`		A 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.
`title`	`string`	Yes	The title of the admin page, which is displayed at the top of the page.
`icon`	`string`		The 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

Property	Type	Description
`type`	`string`	The type of the module (`compass:adminPage`)
`url`	`string`	The URL of the admin page.

UI kit

Property	Type	Description
`type`	`string`	The type of the module (`compass:adminPage`)
`url`	`string`	The URL of the admin page.