Web Item

A key to identify this module.

This key must be unique relative to the add on, with the exception of Confluence macros: Their keys need to be globally unique.

Keys must only contain alphanumeric characters and dashes.

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:

1
2
3
4
5
6
7
8
9

{
    "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.

The location in the application interface where the web item 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.

Places in the Atlassian UI are identified by what are known as "well-known locations". For example, the system.admin/globalsettings location is in the administrative menu on the left side of the Administration Console.

Find product locations with the Web Fragment Finder

• Jira Locations
• Confluence locations

A human readable name.

Represents a string that can be resolved via a localization properties file. You can use the same i18n Property key and value in multiple places if you like, but identical keys must have identical values.

Example

1
2
3
4

{
  "value": "My text"
}

Returns whether the URL should be cacheable. Cacheable URLs are taken directly from the add-on descriptor, and lack all additional query parameters:

• standard iframe query parameters
• product context parameters
• JWT token

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

• page
• PAGE
• addon
• ADDON
• product
• PRODUCT

The context for the URL parameter. Not applicable if an absolute URL is specified. Possible values

• addon - a URL relative to the add-on's base URL
• page - targets a Page module by specifying the Page's module key as the URL
• product - a URL relative to the product's base URL

An optional icon to display with the link text or as the link, specified by URL to its hosted location. You can specify a particular width and height for the icon. Most link icons in Atlassian applications are 16 by 16 pixels.

Defines an icon to display.

Example

1
2
3
4
5
6
7
8

{
  "icon": {
    "width": 16,
    "height": 16,
    "url": "/my-icon.png"
  }
}

This object represents a map of key/value pairs, where each property name and value corresponds to the parameter name and value respectively.

Example

1
2
3
4
5
6
7

{
  "params": {
    "someOtherProperty": "someValue",
    "myCustomProperty": "myValue"
  }
}

Specifies custom styles for the web item target page, if desired. By default, the web item content gets styled in the default style of the target application. It must only contain alphanumeric characters, dashes, underscores and must only start with alpha characters or underscores.

Defines the behaviour when the item is triggered. If omitted, the url behaves as a regular hyperlink.

Defines the way a web item link is opened in the browser, such as in a modal or inline dialog.

Inline Dialog Example

1
2
3
4
5
6
7
8
9
10
11

{
  "target": {
    "type": "inlinedialog",
    "options": {
      "onHover": true,
      "offsetX": "30px",
      "offsetY": "20px"
    }
  }
}

Dialog Example

1
2
3
4
5
6
7
8
9
10

{
  "target": {
    "type": "dialog",
    "options": {
      "height": "100px",
      "width": "200px"
    }
  }
}

Common Dialog Module Example

1
2
3
4
5
6
7
8
9

{
  "target": {
    "type": "dialogmodule",
    "options": {
      "key": "dialog-module-key"
    }
  }
}

More details for this use-case can be found on the Dialog Module page.

The internationalised text to be used in the link's tooltip.

Represents a string that can be resolved via a localization properties file. You can use the same i18n Property key and value in multiple places if you like, but identical keys must have identical values.

Example

1
2
3
4

{
  "value": "My text"
}

Specifies the destination of the web item. The interpretation of this field depends on the value of the

1

context

field.

This field is required if the target of the item is not a Dialog Module.

Your add-on can receive additional context from the application by using variable tokens in the URL attribute.

Determines the order in which the web item 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.