• About Jira Software modules
  • Admin Page
  • Administration UI locations
  • Boards
  • Build
  • Dashboard Item
  • Deployment
  • Development Tool
  • Dialog
  • Entity Property
  • Feature Flag
  • Global Permission
  • Home container
  • Issue Background Script
  • Issue Content
  • Issue Field
  • Issue Glance
  • Issue view UI locations
  • Keyboard Shortcut
  • Page
  • Project Admin Tab Panel
  • Project Page
  • Project Permission
  • Project settings UI locations
  • Project sidebar
  • Remote Link
  • Report
  • Search Request View
  • Tab Panel
  • Time Tracking Provider
  • User profile menu
  • Web Item
  • Web Panel
  • Web Section
  • Webhook
  • Workflow Condition
  • Workflow Post Function
  • Workflow Validator

Issue Glance

This module adds a special user interface element that appears in the right side of the new 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: { type: 'lozenge', value: { label: 'Hello', type: 'default' } }. For available lozenge types, refer to lozenge appearance.
  • Icon: { type: 'icon', value: { label: '/img/tick.png' } }. Note that label is the URL relative to your app's base URL.
  • Badge: { 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
{
  "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
3
AP.events.on('ISSUE_GLANCE_OPENED', function() {
        // You can decide the logic here in add-on.
  });

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

Type
object
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
object
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.


key

Type
string
Max length
100
Required
Yes
Pattern
^[a-zA-Z0-9-]+$

name

Type
object
Required
Yes

target

Type
object
Required
Yes
Description

Specifies the target action when clicking on the glance.

Read about Issue Glance Target Web Panel.


conditions

Type
[singleConditionBean,compositeConditionBean, ... ]

jiraNativeAppsEnabled

Type
boolean
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.


  • System status
  • Privacy
  • Developer Terms
  • Trademark
  • Cookie Preferences
  • © 2019 Atlassian