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": "http://www.example.com/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

location

Type
string
Required
Yes
Description

Location in the application interface for this panel.

Product location documentation:

name

Type
i18n Property
Required
Yes
Description

A human readable name.

key

Type
string
Required
Yes
Description

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

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

example: "My Addon Key" will become "my-addon-key"

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.

url

Type
string

uri-template
Required
Yes
Description

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

conditions

Type
[ Composite Condition, Single Condition, … ]
Description

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

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

layout

Type
Web Panel Layout
Description

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

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.