Content Byline 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.

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.

An optional Content Property key that this Byline Item will be bound to.

The key must only contain alphanumeric characters and dashes.

When a key is supplied, the:

• name
• icon and
• tooltip

for this Byline item will be overwritten with the property's corresponding value (if present), and the rendered item will be updated as the value changes in the browser.

This requires the stored Content Property to have the following format:

1
2
3
4
5
6
7
8
9
10
11
12
13
14

{
  "name": {
    "value": "Item Text"
  },
  "icon": {
    "width": 16,
    "height": 16,
    "url": "/my-icon.png"
  },
  "tooltip": {
    "value": "Item Tooltip"
  }
}

Note that only fields present in the original bean will be respected when substituting values from a Content Property later. This means that to show a Content-Property-based tooltip, this Content Byline Item module must specify a tooltip. Likewise for a Content-Property-based icon, this module must specify an icon.

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

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.