Support for Server products ended Feb. 15, 2024. Learn what this means for you.

Plugin decorators

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

References

Example reference plugin: bitbucket-example-plugin
Tutorial: decorating the user profile
Tutorial: decorating the user account

Decorators

Meta tags must be provided when listed, for example:

1
2
<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:

Decorator	Description	Since	Required Metadata
atl.general	Generic page layout	4.0	None
atl.popup	Generic page layout	4.0	None
atl.userprofile	User account decorator, same as bitbucket.users.account	1.0	1 2 `<meta name="userSlug" content="{$user.slug}"> <meta name="tab" content="your-web-item-key">`
atl.admin	Admin layout	4.0	None
bitbucket.form	Deprecated. Use a specific `bitbucket.focused.*` decorator instead.	4.0	None
bitbucket.focused.small	Small form layout, for example the Bitbucket Data Center login page.	4.0	None
bitbucket.focused.medium	The most widely used layout in Bitbucket Data Center, such as the create repository page.	4.0	None
bitbucket.focused.large	A wide page layout.	4.0	None
bitbucket.focused.xlarge	Close to full width page layout, for example the create pull request page.	4.0	None
bitbucket.project.general	Project page layout	4.0	1 2 `<meta name="projectKey" content="{$project.key}"> <meta name="activeTab" content="your-web-item-key">`
bitbucket.project.settings	Project settings page layout	4.0	1 2 `<meta name="projectKey" content="{$project.key}"> <meta name="activeTab" content="your-web-item-key">`
bitbucket.repository.general	Repository page layout	4.0	1 2 `<meta name="projectKey" content="{$repository.project.key}"> <meta name="repositorySlug" content="{$repository.slug}"> <meta name="activeTab" content="your-web-item-key">`
bitbucket.repository.settings	Repository settings layout	4.0	1 2 `<meta name="projectKey" content="{$repository.project.key}"> <meta name="repositorySlug" content="{$repository.slug}"> <meta name="activeTab" content="your-web-item-key">`
bitbucket.users.account	User account layout, same as atl.userprofile	4.0	1 2 `<meta name="userSlug" content="{$user.slug}"> <meta name="activeTab" content="your-web-item-key">`
bitbucket.users.profile	User profile layout	4.0	1 2 `<meta name="userSlug" content="{$user.slug}"> <meta name="activeTab" content="your-web-item-key">`