Documentation
Web Panel
Adds a panel (or section) to a page in the Atlassian application. Panels let you present related information and controls in the application interface as a group. For example, the existing "People" panel in JIRA issue view shows the assignee, reporter, and similar information for the issue.
Example
{ "modules": { "webPanels": [ { "url": "/web-panel", "location": "com.atlassian.jira.plugin.headernav.left.context", "layout": { "width": "10px", "height": "100%" }, "weight": 50, "key": "my-web-panel", "name": { "value": "My Web Panel" } } ] } } Properties
name
Type
Required
Description
A human readable name.
key
Type
string^[a-zA-Z0-9-]+$Required
Description
A key to identify this module.
This key must be unique relative to the add on, with the exception of Confluence macros: Their keys need to be globally unique.
Keys must only contain alphanumeric characters and dashes.
The key is used to generate the url to your add-on's module. The url is generated as a combination of your add-on key and module key. For example, an add-on which looks like:
{ "key": "my-addon", "modules": { "configurePage": { "key": "configure-me", } } } Will have a configuration page module with a URL of /plugins/servlet/ac/my-addon/configure-me.
location
Type
stringRequired
Description
Location in the application interface for this panel.
Product location documentation:
url
Type
stringuri-templateRequired
Description
The URL of the add-on resource that provides the web panel content. This URL must be relative to the add-on's baseUrl.
conditions
Type
Single Condition, Composite Condition, … ]Description
Conditions can be added to display only when all the given conditions are true.
tooltip
Type
Description
Information about the web panel that will be shown when hovering over its header
params
Type
objectDescription
This object represents a map of key/value pairs, where each property name and value corresponds to the parameter name and value respectively.
Example
{ "params": { "someOtherProperty": "someValue", "myCustomProperty": "myValue" } } layout
Type
Description
The width and height of the web panel on the page.
weight
Type
integerDescription
Determines the order in which web panels appear. Web panels are displayed top to bottom or left to right in order of ascending weight. The "lightest" weight is displayed first, while the "heaviest" weights sink to the bottom. The weight values for most panels start from 100, and the weights for the links generally start from 10. The weight is incremented by 10 for each in sequence to leave room for custom panels.
