Jira issue context

The jira:issueContext module adds a collapsible panel under the other fields on the right side of the issue view. These panels give your users a quick way to get information related to the issue from your app. Users can expand these panels to view app information or collapse them if they don’t need it.

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.

See the IssueContext component documentation for more information.

Properties

Status properties

Status value properties

Dynamic properties

To use dynamic properties, you must declare them in your app's manifest.yml. Your app must also implement a dynamicProperties handler function.

Jira will retrieve your app's dynamic properties on initial render, which happens when the issue context panel is first expanded. Your app will then render inside the issue context panel and execute its business logic.

When the issue context panel is collapsed, Jira will call your app's dynamicProperties handler function and update the status based on what the function returns.

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:issueContext";
    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

Custom UI

Use the getContext bridge method to access the extension context in custom UI.

UI kit

Use the useProductContext hook to access the context in UI kit.

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.