Bitbucket modules
Common modules
Compass modules
Confluence modules
Jira modules
Jira Service Management modules

Compass team page

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

Example of a team page app

You can use the 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 team 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 team page.
resourcestringA reference to the static resources entry that your team page wants to display. See resources for more details.
render'native'Yes for UI Kit 2Indicates if the module is a UI Kit 2 module.
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.

Can only be set if the module is using the resource property.

titlestringYesThe title of the team page, which is displayed on the left navigation and at the top of the page.
iconstring

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.

Extension context

Custom UI

PropertyTypeDescription
typestringThe type of the module (compass:teamPage)
teamIdstringThe unique Atlassian resource identifier (ari) for the team.

UI kit

PropertyTypeDescription
typestringThe type of the module (compass:teamPage)
teamIdstringThe unique Atlassian resource identifier (ari) for the team.

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.

Rate this page: