The bitbucket:repoPullRequestCard
module adds a card on the right hand sidebar of the pull request 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: |
resource | string | If using Custom UI or modern versions of UI Kit | The key of a static resources entry that your module will display. See resources for more details. |
render | 'native' | If using modern versions of UI Kit | Indicates the module uses UI Kit. |
function | string | Deprecated Required if using UI Kit 1 | The key of a function module that returns a UI Kit 1 component. |
resolver | { function: string } or{ endpoint: string } |
Set the Set the | |
title |
| Yes |
The title of the card which is displayed. |
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. |
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. |
repository | object | The repository where this card is displayed in. |
repository.uuid | string | The repository UUID which will be wrapped in {} . |
pullRequest | object | The pull request where this card is displayed on. |
pullRequest.id | integer | The pull request id. |
Some Forge APIs (for example, storage API) do not support {}
. You can use the unwrapUUid
and
wrapUuid
functions to convert a Bitbucket resource ID between a wrapped and unwrapped UUID. See
unwrapUuid/wrapUuid helper functions
for more information.
Use the useProductContext hook to access the context in UI Kit 1.
Property | Type | Description |
---|---|---|
type | string | The type of the module. |
repository | object | The repository where this card is displayed in. |
repository.uuid | string | The repository UUID which will be wrapped in {} . |
pullRequest | object | The pull request where this card is displayed on. |
pullRequest.id | integer | The pull request id. |
Rate this page: