Jira issue glance

The jira:issueGlance module adds an issue glance to Jira, which is content that is shown/hidden in an issue by clicking a button. The button for the issue glance is placed alongside fields such as Assignee and Labels. Clicking the button opens the content provided by the Forge app, so that it fills the right sidebar.

This module can be used in Jira Work Management, Jira Software, and Jira Service Management. It works in the new issue view but not the old issue view.

For UI Kit 1, see the IssueGlance component documentation for more information.

Manifest example

1
2
modules:
  jira:issueGlance:
    - key: hello-world-issue-glance
      resource: main
      resolver:
        function: resolver
      render: native
      title: Hello World!
      description: A hello world issue glance.
      label: Hello World!

Properties

Status properties

Status value properties

Dynamic properties

Dynamic properties are used to dynamically update the status properties. If provided in the manifest.yml file, Jira attempts to retrieve the dynamic properties on the initial render of the app. To do this, the dynamicProperties handler function of the app is called. When the issue glance item is clicked, the app renders in the side panel, where it can perform business logic updates. After the side panel is closed, the handler function is called to retrieve updates, and then update the status.

The app's handler function is passed the payload argument. The payload object has the following structure:

1
2
interface Payload {
  // The cloudId for your site 
  cloudId: string;
  extension: {
    // The module type included in the manifest.yml file.
    type: "jira:issueGlance";
    issue: {
      id: string,
      type: string,
      key: string,
      typeId: string
    },
    project: {
      id: string,
      type: string,
      key: string
    }
  };
}

The handler function should return (or resolve with) a plain JavaScript object with status as key.

This is an example of a handler function returning an object:

1
2
function handlerFunction(contextPayload) {
  return {
    "status": {
      "type": "lozenge",
      "value": {
        "label": "Dynamically set status",
        "type": "moved"
      }
    }
  };
}

Extension data

UI Kit and Custom UI

Use the useProductContext hook to access the extension context in UI Kit or getContext bridge method in custom UI.

UI Kit 1

Use the useProductContext hook to access the context in UI Kit 1.

Extension context

Platform context

Events

Apps can receive a frontend event that will notify your app that an issue has been changed. This event is triggered when an issue is updated or commented on. This event is only available for Jira issue view modules.

1
2
import {events} from '@forge/bridge';
    events.on('JIRA_ISSUE_CHANGED', (data) => {
    console.log('JIRA_ISSUE_CHANGED (Forge)', data);
});

However, if you have multiple issue view modules in your app, you should use the Jira issue view background script module or its Connect counterpart. 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
    }]
}

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.