• About Jira Service Management modules
  • Admin Page
  • Administration UI locations
  • Agent view
  • Automation action
  • Build
  • Customer portal
  • Dashboard Item
  • Deployment
  • Deployment gating
  • 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
  • Portal icon
  • Project Admin Tab Panel
  • Project Page
  • Project Permission
  • Project settings UI locations
  • Project sidebar
  • Report
  • Request create property panel
  • Search Request View
  • Tab Panel
  • Time Tracking Provider
  • User profile menu
  • Web Item
  • Web Panel
  • Web Section
  • Web item target
  • Webhook
  • Workflow Condition
  • Workflow Post Function
  • Workflow Validator

Issue Content

This module adds a quick-add button alongside the existing quick-add buttons for attachments, subtasks, and linked issues in the new Jira issue view. Users will use your quick-add button to add content to help describe, and ultimately resolve, an issue.

When a user clicks on your app's quick-add button, a panel is added below the issue description that displays content from a URL provided by your app (similar to the web panel module). This URL must be a relative URL from your app's server.

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
30
{
  "modules": {
    "jiraIssueContents": [
      {
        "icon": {
          "width": 0,
          "height": 0,
          "url": "/my_icon.svg"
        },
        "target": {
          "type": "web_panel",
          "url": "/url_to_panel_content_page.htm"
        },
        "tooltip": {
          "value": "This is a tooltip"
        },
        "contentPresentConditions": [
          {
            "condition": "user_is_admin",
            "invert": false
          }
        ],
        "name": {
          "value": "My Issue Content Panel"
        },
        "key": "my-issue-content-panel"
      }
    ]
  }
}

ISSUE_QUICK_ADD_CLICKED event

When a user clicks your quick-add button, the ISSUE_QUICK_ADD_CLICKED event is sent. You can listen for this event using the JavaScript API. Here's an example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
AP.events.on('ISSUE_QUICK_ADD_CLICKED', function(event){
  // display a dialog when quick add button was clicked. event = { isNewToIssue: boolean }
  // isNewToIssue is true if this is first time content panel being added to current issue.
  // isNewToIssue is false if content panel is already on issue view, and it is selected.
  AP.dialog.create({
        key: 'sized-panel',
        width: '500px',
        height: '200px',
        chrome: true,
        header: JSON.stringify(event)
  });
 });

You can use this to design an experience where you want a user to input, select, or review information before interacting with your web panel.

Find out more about recommended usage and get user experience suggestions in the design guidelines.

Properties

icon

Type
object
Required
Yes
Description

Specifies an icon to show alongside the quick-add menu item. The icon 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 of this content as a result of clicking on the menu item. Currently, you can only display a web panel in the issue's content area.

Read about Issue Page Target Web Panel.


tooltip

Type
object
Required
Yes
Description

Specifies a tooltip for the quick-add menu item.


conditions

Type
[singleConditionBean,compositeConditionBean, ... ]

contentPresentConditions

Type
[singleConditionBean,compositeConditionBean, ... ]
Description

Specifies a list of Conditions that, when resolved to true, will force the content to always be displayed for that issue. Users have the ability to collapse the content if they don't want to see it.


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