Documentation

Project Tab Panel

Tab panel modules allow add-ons to insert new tabs into various parts of the host applications user interface.

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.

Example

{
  "jiraComponentTabPanels": [
    {
      "url": "/my-component-tab",
      "weight": 100,
      "key": "my-component-tab",
      "name": {
        "value": "My Component Tab Page"
      }
    }
  ]
}

Properties

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

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

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

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.