The compass:componentPage
module adds an item to the left navigation on the Compass component details page.
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 | Required if using UI Kit 1 or triggers. | A reference to the function module that defines the module. |
resource | string | Required if using custom UI or the latest 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 Set the |
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 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. | |
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. |
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. |
Property | Type | Description |
---|---|---|
type | string | The type of the module (compass:componentPage ) |
componentId | string | The unique Atlassian resource identifier (ari ) for the component. |
Rate this page: