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

{
  "webPanels": [
    {
      "location": "com.atlassian.jira.plugin.headernav.left.context",
      "layout": {
        "width": "10px",
        "height": "100%"
      },
      "url": "http://www.example.com/web-panel",
      "weight": 50,
      "name": {
        "value": "My Web Panel"
      }
    }
  ]
}

Properties

name

Type
i18n Property
Required
Yes
Description

A human-readable name

conditions

Type
[ Single Condition, Composite Condition, … ]
Description

Conditions can be added to display only when all the given conditions are true.

key

Type
string
Description

An OPTIONAL key to identify this module. This key must be unique relative to the add on.

For most modules a key does not have to be specified as a random key will be assigned for each module. A key only needs to be specified when it needs to be known for use in other modules or content.

For example, if you need to create a page and have the content of the page link to iteself or another page module you'll need to specify the key(s) for the page(s) so that you can determine the url to link to.

All specified keys will have all special characters and spaces replaced with dashes and will be lower cased.

example: "MyAddon Key" will become "myaddon-key"

layout

Type
Web Panel Layout
Description

The width and height of the web panel on the page.

location

Type
string
Description

Location in the application interface for this panel.

params

Type
object
Description

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"
  }
}

url

Type
string
Description

The URL of the add-on resource that provides the web panel content.

weight

Type
integer
Description

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.