Plugin decorators

By decorating a page, Bitbucket Server plugins are able to inject data into preexisting page layouts.

References

Decorators

Meta tags must be provided when listed, for example:

1
2
3
4
5
6
<head>
    <meta name="decorator" content="bitbucket.project.general" />
    <meta name="projectKey" content="{$project.key}" />
    <meta name="activeTab" content="project-plugin-tab" />
    <title>{$project.key} / Example Tab</title>
</head>

The following decorators are available:

DecoratorDescriptionSinceRequired Metadata
atl.generalGeneric page layout4.0None
atl.popupGeneric page layout4.0None
atl.userprofileUser account decorator, same as bitbucket.users.account1.0
1
2
<meta name="userSlug" content="{$user.slug}">
<meta name="tab" content="your-web-item-key">
atl.adminAdmin layout4.0None
bitbucket.formDeprecated. Use a specific bitbucket.focused.* decorator instead.4.0None
bitbucket.focused.smallSmall form layout, for example the Bitbucket Server login page.4.0None
bitbucket.focused.mediumThe most widely used layout in Bitbucket Server, such as the create repository page.4.0None
bitbucket.focused.largeA wide page layout.4.0None
bitbucket.focused.xlargeClose to full width page layout, for example the create pull request page.4.0None
bitbucket.project.generalProject page layout4.0
1
2
<meta name="projectKey" content="{$project.key}">
<meta name="activeTab" content="your-web-item-key">
bitbucket.project.settingsProject settings page layout4.0
1
2
<meta name="projectKey" content="{$project.key}">
<meta name="activeTab" content="your-web-item-key">
bitbucket.repository.generalRepository page layout4.0
1
2
3
<meta name="projectKey" content="{$repository.project.key}">
<meta name="repositorySlug" content="{$repository.slug}">
<meta name="activeTab" content="your-web-item-key">
bitbucket.repository.settingsRepository settings layout4.0
1
2
3
<meta name="projectKey" content="{$repository.project.key}">
<meta name="repositorySlug" content="{$repository.slug}">
<meta name="activeTab" content="your-web-item-key">
bitbucket.pullrequest.viewPull request layout4.0
1
2
3
4
<meta name="projectKey" content="{$repository.project.key}">
<meta name="repositorySlug" content="{$repository.slug}">
<meta name="pullRequestId" content="{$pullRequest.id}">
<meta name="activeTab" content="your-web-item-key">
bitbucket.users.accountUser account layout, same as atl.userprofile4.0
1
2
<meta name="userSlug" content="{$user.slug}">
<meta name="activeTab" content="your-web-item-key">
bitbucket.users.profileUser profile layout4.0
1
2
<meta name="userSlug" content="{$user.slug}">
<meta name="activeTab" content="your-web-item-key">