Bitbucket workspace settings menu page

On This Page

Properties
Extension context

The bitbucket:workspaceSettingsMenuPage module adds an item in the FORGE APPS section of the left navigation of Bitbucket workspace settings menu. 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}/workspace/settings/forge/{forgeAppId}/{forgeEnvironmentKey}/{forgeAppModuleKey}

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 page which is displayed. The `i18n object` allows for translation. See i18n object.

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

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