Bitbucket workspace settings menu page

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}/{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_-]+$`
`title`	`string`	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 workspace settings 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 `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.

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 `{}`.

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 `{}`.