Documentation
Web Section
The Web Section plugin module allows add-ons to define new sections in application menus. Each section can contain one or more links. To insert the links themselves, see the Web Item Module.
Example
{
"webSections": [
{
"location": "com.atlassian.jira.plugin.headernav.left.context",
"weight": 50,
"name": {
"value": "My Web Section"
}
}
]
}
Properties
location
Type
stringRequired
Description
The location in the application interface where the web section should appear. For the Atlassian application interface, a location is something like the coordinates on a map. It points to a particular drop-down menu or navigation list in the UI.
Product location documentation:
name
Type
Required
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
stringDescription
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: "My Addon Key" will become "my-addon-key"
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"
}
}
tooltip
Type
Description
The internationalised text to be used in the link's tooltip.
weight
Type
integerDefaults to
100Description
Determines the order in which the web section 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 sections have weights that are incremented by numbers that leave room for additional sections, 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.