Modules
Display conditions

Rate this page:

Compass component page

The compass:componentPage module adds an item to the left navigation on the Compass component details page. You can use 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 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.
resourcestringA reference to the static resources entry that your component 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 component page, which is displayed on the left navigation and 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.
displayConditionsobjectA 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

PropertyTypeDescription
typestringThe type of the module (compass:componentPage)
componentIdstringThe unique Atlassian resource identifier (ari) for the component.

UI kit

PropertyTypeDescription
typestringThe type of the module (compass:componentPage)
componentIdstringThe unique Atlassian resource identifier (ari) for the component.

Rate this page: