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

Dynamic properties are used to dynamically update the status property. 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 context item is clicked, the app renders in the collapsible panel, where it can perform business logic updates. After the panel is collapsed, 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.
    // In this case, it is the "jira:issueContext" module.
    type: string;
    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