Content Byline Item modules allow your Connect add-on to add dynamic content to the Confluence Content Byline - the part of the content under the title that includes metadata about the latest version of the content.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
{
"modules": {
"contentBylineItems": [
{
"url": "/my-byline-item",
"context": "addon",
"target": {
"type": "inlinedialog"
},
"tooltip": {
"value": "Item Tooltip"
},
"icon": {
"width": 16,
"height": 16,
"url": "/my-icon.png"
},
"name": {
"value": "Item Text"
},
"key": "byline-item"
}
]
}
}
key
Type | |
Max length | 100 |
Required | Yes |
Pattern | ^[a-zA-Z0-9-]+$ |
Description | 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: { "key": "my-addon", "modules": { "configurePage": { "key": "configure-me", } } }
Will have a configuration page module with a URL of |
name
Type | |
Required | Yes |
Description | A human readable name. Represents a string that can be resolved via a localization properties file. You can use the same Example1 2 3 4
|
value |
| ||||||||
i18n |
|
cacheable
Type | |
Defaults to | false |
Description | Returns whether the URL should be cacheable. Cacheable URLs are taken directly from the add-on descriptor, and lack all additional query parameters:
|
conditions
Type | |
Description | Conditions can be added to display only when all the given conditions are true. |
contentPropertyKey
Type | |
Max length | 100 |
Pattern | ^[a-zA-Z0-9-]+$ |
Description | 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: 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
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 |
context
Type | |
Defaults to | addon |
Allowed values |
|
Description | The context for the URL parameter. Not applicable if an absolute URL is specified. Possible values
|
icon
Type | |
Description | 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. Example1 2 3 4 5 6 7 8
|
url |
| ||||||||
height |
| ||||||||
width |
|
params
Type | |
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 1 2 3 4 5 6 7
|
target
Type | |
Description | 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 Example1 2 3 4 5 6 7 8 9 10 11
Dialog Example1 2 3 4 5 6 7 8 9 10
Common Dialog Module Example1 2 3 4 5 6 7 8 9
More details for this use-case can be found on the Dialog Module page. |
options |
| ||||||||
type |
|
tooltip
Type | |
Description | 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 Example1 2 3 4
|
value |
| ||||||||
i18n |
|
url
Type | |
Format | uri-template |
Description | Specifies the destination of the web item. The interpretation of this field depends on the value of the 1
field.
This field is required if the Your add-on can receive additional context from the application by using variable tokens in the URL attribute. |
Rate this page: