Developer
News and Updates
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Security for Connect apps
Framework overview
Building blocks
Modules
JavaScript API
Last updated Feb 24, 2026

Repo page

Module for pages in the repo sidebar menu

Properties

key

Typestring
Max length128
RequiredYes
Pattern^[a-zA-Z0-9-]+$
DescriptionA key to identify this module. This key must be unique across all modules defined by your app.

location

Type
string
Max length
128
Required
Yes
Allowed values
  • org.bitbucket.repository.actions
  • org.bitbucket.repository.navigation
Description

Location in the application interface.

name

Typei18n-property
RequiredYes
DescriptionRepresents a string that can be resolved via a localization properties file. You can use the same i18n Property key and value in multiple places, but identical keys must have identical values.

Properties

i18n
Type
string
Description

The localization key for i18n. You can use the i18n localization key in your apps, however, Bitbucket does not currently support localization.

value
Type
string
Description

The human-readable value.

url

Type
string
Max length
2048
Format
uri-template
Required
Yes

conditions

Type
[Simple condition, Composition condition, ...]
Description

Conditions control whether or not a module will be displayed based on the current context. See Conditions for more details

icon

Type
[Simple condition, Composition condition, ...]
Description

Conditions control whether or not a module will be displayed based on the current context. See Conditions for more details

Properties

url
Type
string
Format
uri
Required
Yes
height
Type
integer
width
Type
integer

params

Typeobject

tooltip

Typei18n-property
DescriptionRepresents a string that can be resolved via a localization properties file. You can use the same i18n Property key and value in multiple places, but identical keys must have identical values.

Properties

i18n
Type
string
Description

The localization key for i18n. You can use the i18n localization key in your apps, however, Bitbucket does not currently support localization.

value
Type
string
Description

The human-readable value.

weight

Typeinteger
DescriptionDetermines the order in which the web item appears in the menu or list. The "lightest" weight (i.e., lowest number) appears first, rising relative to other items, while the "heaviest" weights sink to the bottom of the menu or list.

Rate this page: