Tab Panel

Tab panel modules allow add-ons to insert new elements into the following tabbed sections of the host application's user interface.

  • Issue page Activity section
  • Project page sidebar

The tab panel module takes care of integrating the add-on content into the application for you. The add-on content automatically gets the tab panel styles and decorators from the host application.

jiraProjectTabPanels and jiraProfileTabPanels are deprecated as of 1 October 2017.

The initial location for jiraProjectTabPanels was phased out of Jira Cloud in March 2015. We recommend that apps implement web items and web panels in the Jira project sidebar instead. Support for jiraProfileTabPanels has been removed. If your app has user-specific content, we recommend you create a general page and a link to this page from the user profile menu.

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
  "modules": {
    "jiraIssueTabPanels": [
      {
        "url": "/my-issue-tab",
        "weight": 100,
        "name": {
          "value": "My Issue Tab Panel"
        },
        "key": "my-issue-tab"
      }
    ],
    "jiraProjectTabPanels": [
      {
        "url": "/my-project-tab",
        "weight": 100,
        "name": {
          "value": "My Project Tab Panel"
        },
        "key": "my-project-tab"
      }
    ]
  }
}

Properties

key

Type
string
Max length
100
Required
Yes
Pattern
^[a-zA-Z0-9-]+$

name

Type
object
Required
Yes

url

Type
string
Format
uri-template
Required
Yes
Description

Specifies the URL targeted by the tab panel. The URL is relative to the add-on's base URL.

conditions

Type
[compositeConditionBean,singleConditionBean, ... ]

params

Type
object

weight

Type
integer
Description

Determines the order in which the tab panel's link appears in the menu or list.

The "lightest" weight (i.e., lowest number) appears first, rising relative to other items, while the "heaviest" weights sink to the bottom of the menu or list.

Built-in web items have weights that are incremented by numbers that leave room for additional items, such as by 10 or 100. Be mindful of the weight you choose for your item, so that it appears in a sensible order given existing items.