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.

See the IssueGlance component documentation for more information.

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.
    // In this case, it is the "jira:issueGlance" 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