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

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`	Required if using UI Kit 1.	A reference to the function module that defines the module. Only used in UI Kit 1.
`resource`	`string`	Required if using custom UI or the current version of UI Kit.	A reference to the static `resources` entry that your context menu app wants to display. See resources for more details.
`render`	`'native'`	Yes for UI Kit.	Indicates the module uses UI Kit.
`resolver`	`{ function: string }` or `{ endpoint: string }`	Yes	Set the `function` property if you are using a hosted `function` module for your resolver. Set the `endpoint` property if you are using Forge remote (preview) to integrate with a remote back end.
`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

UI Kit and Custom UI

Use the useProductContext hook to access the extension context in UI Kit or getContext bridge method in 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 1

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