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

Repository overview card

The bitbucket:repoCodeOverviewCard module adds a card on the right hand sidebar of the repository source page.

Example of an repository code overview card

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_-]+$

title

string

Yes

The title of the card which is displayed.

functionstringThis 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 repository code overview card.
resourcestringRequired 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.

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

UI Kit and Custom UI

Use the useProductContext hook to access the extension context in UI Kit or getContext bridge method in custom UI.

PropertyTypeDescription
typestringThe type of the module.
repositoryobjectThe repository where this card is displayed in.
repository.uuidstringRepository UUID which will be wrapped in {}.

UI Kit 1

Use the useProductContext hook to access the context in UI Kit 1.

PropertyTypeDescription
typestringThe type of the module.
repositoryobjectThe repository where this card is displayed in.
repository.uuidstringRepository UUID which will be wrapped in {}.

Rate this page: