Bitbucket modules
Common modules
Compass modules
Confluence modules
Jira modules
Jira Service Management modules

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}

Example of a workspace settings menu page

Properties

PropertyTypeRequiredDescription
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.

functionstringThis 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.
resourcestringA reference to the static resources entry that your page wants to display. See resources for more details.
render'native'Yes for UI Kit 2Indicates if the module is a UI Kit 2 module.
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 (preview) to integrate with a remote back end.

Can only be set if the module is using the resource property.

Extension context

Custom UI

Use the getContext bridge method to access the extension context in custom UI.

PropertyTypeDescription
typestringThe type of the module.
workspaceobjectThe workspace where this page is displayed in.
workspace.uuidstringThe workspace UUID which will be wrapped in {}.

UI kit

Use the useProductContext hook to access the context in UI Kit.

PropertyTypeDescription
typestringThe type of the module.
workspaceobjectThe workspace where this page is displayed in.
workspace.uuidstringThe workspace UUID which will be wrapped in {}.

UI kit 2

This module now has support for UI Kit 2 (preview) for faster user experiences and to access additional React features.

For more information on all the supported modules, see the Supported products and their modules section.

Rate this page: