Compass component page

The compass:componentPage module adds an item to the left navigation on the Compass component details page.

Example of a component page app

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 component 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 component page.
`resource`	`string`		A reference to the static `resources` entry that your component 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 component page, which is displayed on the left navigation and at the top of the page.
`icon`	`string`		The icon displayed next to the `title`. For custom UI and UI kit apps, the `icon` property accepts a relative path from a declared resource. Alternatively, you can also use an absolute URL to a self-hosted icon. See Icons for more information. If no icon is provided, or if there's an issue preventing the icon from loading, a generic app icon will be displayed.
`displayConditions`	`object`		A list of component types for which the module should be displayed, for example: `componentTypes: [APPLICATION, SERVICE]` If `displayConditions` is omitted, the module is displayed for all component types.

Extension context

Custom UI

Property	Type	Description
`type`	`string`	The type of the module (`compass:componentPage`)
`componentId`	`string`	The unique Atlassian resource identifier (`ari`) for the component.

UI kit

Property	Type	Description
`type`	`string`	The type of the module (`compass:componentPage`)
`componentId`	`string`	The unique Atlassian resource identifier (`ari`) for the component.

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.