Bitbucket 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

Property	Type	Required	Description
`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_-]+$`
`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 `function` property if you are using a hosted `function` module for your resolver. Set the `endpoint` property if you are using Forge remote to integrate with a remote back end.
`title`	`string` or `i18n object`	Yes	The title of the card which is displayed. The `i18n object` allows for translation. See i18n object.
`icon`	`string`		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.

i18n object

Key	Type	Required	Description
`i18n`	`string`	Yes	A key referencing a translated string in the translation files. For more details, see Translations.

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.

Property	Type	Description
`type`	`string`	The type of the module.
`repository`	`object`	The repository where this card is displayed in.
`repository.uuid`	`string`	Repository UUID which will be wrapped in `{}`.
`location`	`string`	The full URL of the host page where this card is displayed in.

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.

UI Kit 1

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`	Repository UUID which will be wrapped in `{}`.
`location`	`string`	The full URL of the host page where this card is displayed in.