The bitbucket:repoMainMenuPage
module adds a menu item at the bottom of the left navigation of Bitbucket repository pages.
When you click the menu item, the content will render on a new Bitbucket page. You can use the UI Kit or custom UI to create content for this page.
The page URL is constructed in the form of: /{workspaceSlug}/{repositorySlug}/forge/{forgeAppId}/{forgeAppModuleKey}
Property | Type | Required | Description |
---|---|---|---|
key |
| Yes |
A key for the module, which other modules can refer to. Must be unique within the manifest. Regex: |
title |
| Yes |
The title of the page which is displayed. |
function | string | This 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 main menu page. |
resource | string | Required if using custom UI or the latest 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 Set the |
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 page is displayed in. |
repository.uuid | string | The repository UUID which will be wrapped 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.
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 page is displayed in. |
repository.uuid | string | The repository UUID which will be wrapped in {} . |
Rate this page: