Issue Glance

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.

Setting the status for a Glance

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:

Lozenge

1
2
{ type: 'lozenge', value: { label: 'Hello', type: 'default' } }

For available lozenge types, refer to lozenge appearance.

Icon

1
2
{ type: 'icon', value: { label: '/img/tick.png' } }

Note that label is the URL relative to your app's base URL.


**Badge**

```json
{ 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
{
  "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 event

When 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
AP.events.on('ISSUE_GLANCE_OPENED', function() {
  // You can decide the logic here in add-on.
});

ISSUE_CHANGED event

Apps 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
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
{
  "issueId": string,
  "projectId": string,
  "changes":[{
    "changeType": "updated" | "commented",
    "atlassianId": string
  }]
}

• issueId - ID of the issue the app is rendered on
• projectId - ID of the project the issue belongs to
• changes - the list of issue changes
• changeType - type of the change
• commented - a new comment was added to the page
• updated - the issue has been updated
• atlassianId - ID of the user who made the change

Limitations

• UI kit apps don't have an event system in place and so aren't supported.
• There is a delay between the moment the issue is modified and when the event is emitted. It might take up to a few seconds.
• We can't guarantee that all issue change events will be received by Jira. Therefore, the issue view may sometimes remain stale.
• When the issue is modified by the user who is currently viewing it, it will not be refreshed. This is because we assume the change was made by that same user and there is no need for an update.

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.

Properties

content

icon

Example

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

Properties

key

Example

For example, an add-on which looks like:

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

name

Example

1
2
{
  "value": "My text"
}

Properties

target

conditions

jiraNativeAppsEnabled