Web item

Adds a web item to a specified location in the application interface. A web item is a hyperlink that's inserted into some standard place in the Bitbucket user interface, such as the repository side bar or header. The form that the link takes can vary depending on the location. In some cases it may render as an item in a drop-down menu, or as a button.

A web item link can open a link to an external site, a new page in the application or a dialog, depending on your configuration.

You can inject additional context from the application (for example, the context repository or current user) by using variable tokens known as "context parameters" in the url.

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.account.admin.mirror.config.actions
  • org.bitbucket.addon.management
  • org.bitbucket.branch.list.actions
  • org.bitbucket.branch.summary.actions
  • org.bitbucket.branch.summary.info
  • org.bitbucket.commit.summary.actions
  • org.bitbucket.commit.summary.info
  • org.bitbucket.pullrequest.summary.actions
  • org.bitbucket.pullrequest.summary.info
  • 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
Pattern
^[a-zA-Z0-9-]+$

conditions
Type
Description

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


context
Type
Allowed values
  • page
  • PAGE
  • addon
  • ADDON
  • product
  • PRODUCT
Description

The context for the URL parameter if the URL is specified as a relative URL. This context can be either addon, which renders the URL relative to the app's base URL, page which targets a page module by specifying the page's module key as the URL or product, which renders the URL relative to the product's base URL.


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

styleClasses
Type
Description

Specifies custom styles for the web item target page.


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