Jira issue glance module in Forge or Connect app being deprecated and replaced. This module is being deprecated and replaced by Jira issue context module on Oct 6, 2023. Check out How to future-proof your Issue Glance implementation on how to migrate.
This module adds a special user interface element that appears in the right side of the Jira issue view under the status and alongside other fields like the assignee, priority, and labels.
Glances provide a quick way for a user to get an overview of some information, provided by your app, that relates to an issue.
The Glance object (which includes your icon, content and URL) is defined using the Issue Glance module.
The status of a Glance for a specific an issue can be set using the Set issue property API.
The issue property key needs to be formatted as com.atlassian.jira.issue:[addonKey]:[moduleKey]:status
to set the status.
The JSON in your PUT request to set the status should follow this format depending on the type of status you wish you display:
{ type: 'lozenge', value: { label: 'Hello', type: 'default' } }
. For available lozenge types, refer to lozenge appearance.{ type: 'icon', value: { label: '/img/tick.png' } }
. Note that label is the URL relative to your app's base URL.{ type: 'badge', value: { label: '123' } }
. Note that label must be a numeric string.More recommended usage and user experience suggestions are available in the design guidelines.
Example
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 27 28 29
{
"modules": {
"jiraIssueGlances": [
{
"icon": {
"width": 0,
"height": 0,
"url": "my_icon.svg"
},
"content": {
"type": "label",
"label": {
"value": "my label"
}
},
"target": {
"type": "web_panel",
"url": "/panel_url"
},
"jiraNativeAppsEnabled": false,
"name": {
"value": "My Issue Glance "
},
"key": "my-issue-glance"
}
]
}
}
ISSUE_GLANCE_OPENED
eventWhen a user clicks a glance, the glance panel slides in and covers the details on the right side of the issue. The ISSUE_GLANCE_OPENED
event is sent. which you can listen for using the JavaScript API. See the example provided below.
1 2 3
AP.events.on('ISSUE_GLANCE_OPENED', function() {
// You can decide the logic here in add-on.
});
ISSUE_CHANGED
eventApps can receive a frontend event notifying them that an issue changed, either by being updated or commented on. This event is only available for Jira issue view modules.
1 2 3
AP.events.on('ISSUE_CHANGED', function (data) {
console.log('ISSUE_CHANGED (Connect)', data);
});
However, if you have multiple issue view modules in your app, you should use the Jira issue view background script module. This will give you a central place for fetching issue details, thus reducing the number of network requests and improving the user experience. Fetching issue details separately for every module would introduce unnecessary overhead and degrade performance.
Data shape
1 2 3 4 5 6 7 8
{
"issueId": string,
"projectId": string,
"changes":[{
"changeType": "updated" | "commented",
"atlassianId": string
}]
}
Limitations
You can use this to load additional web resource or trigger activity in your add-on.
More recommended usage and user experience suggestions are available in the design guidelines.
content
Type | |
Required | Yes |
Description | This content becomes the label next to the icon. It's handy for communicating a small amount of information. Read about Issue Glance Content Label. |
icon
Type | |
Required | Yes |
Description | Specifies an icon to display at the left of the glance view control. The icon resource provided in this field should be 24x24 pixels or larger, preferably in SVG format. Defines an icon to display. Example1 2 3 4 5 6 7 8
|
url |
| ||||||||
height |
| ||||||||
width |
|
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: 1 2 3 4 5 6 7 8 9
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 |
|
target
Type | |
Required | Yes |
Description | Specifies the target action when clicking on the glance. Read about Issue Glance Target Web Panel. |
conditions
Type | |
Description | Conditions can be added to display only when all the given conditions are true. |
jiraNativeAppsEnabled
Type | |
Defaults to | false |
Description | Specifies whether the issue glance will be shown in the Jira mobile and desktop clients. The issue glance will be shown in Jira for iOS/Mac version 109 or later and Jira for Android version 55 or later. Read about enabling your addon for the Jira mobile and desktop clients. |
Rate this page: