Repo page

Module for pages in the repo sidebar menu

Properties

key
Type
Max length
128
Required
Yes
Pattern
^[a-zA-Z0-9-]+$
Description

A key to identify this module. This key must be unique across all modules defined by your app.


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

Location in the application interface.


name
Type
Required
Yes
Description

Represents 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
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
Description

The human-readable value.


url
Type
Max length
2048
Format
uri-template
Required
Yes

conditions
Type
Description

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


icon
Type
Description

This is not fully supported yet. If specified, this will take precedence over any aui icon classes specified via params.auiIcon.

Properties

url
Type
Format
uri
Required
Yes
height
Type
width
Type

params
Type

tooltip
Type
Description

Represents 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
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
Description

The human-readable value.


weight
Type
Description

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