Jira issue context

If your app previously use Issue Glance module and you want to migrate to the Issue Context module. Check out How to future-proof your Issue Glance implementation on how to migrate.

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

Property	Type	Required	Description
`key`	`string`	Yes	A key for the module, which other modules can refer to. Must be unique within the manifest. Regex: `^[a-zA-Z0-9_-]+$`
`function`	`string`	The issue context module requires either a `function` for usage with the UI kit, or a `resource` when building with custom UI.	A reference to the `function` module that defines the issue context. This function must return the IssueContext component.
`resource`	`string`		A reference to the static `resources` entry that your issue context panel wants to display. See resources for more details.
`resolver`	`{ function: string }`		Contains a `function` property, which references the `function` module that defines the configuration of `resource`. Can only be set if the module is using the `resource` property.
`title`	`string`	Yes	The title of the issue context panel, which is displayed next to its label.
`label`	`string`	Yes	The text shown on the button for the issue context panel.
`icon`	`string`		The absolute URL of the icon that is displayed to the left of the label on the button for the issue context panel.
`status`	`object`		The badge, lozenge, or icon shown to the right of the `label`. If `status` is not specified, then nothing is shown. See status properties.
`displayConditions`	`object`		The object that defines whether or not a module is displayed in the UI of the app. See display conditions.

Status properties

Property	Type	Required	Description
`type`	`'badge' \| 'lozenge' \| 'icon'`	Yes	The UI element used to display the status.
`value`	`object`	Yes	This property is an object representing the status value. See status value properties.

Status value properties

Property	Type	Required	Description
`label`	`string`	Yes	The text to display in the status. If `type` is `'badge'`, this property is a number specified as a string (for example, `'3'`).
`url`	`string`		If `type` is `'icon'`, this value controls the URL of the icon to display in the status.
`type`	`'default' \| 'inprogress' \| 'moved' \| 'new' \| 'removed' \| 'success'`		If `type` is `'lozenge'`, this value controls the appearance of the status.

Extension data

Custom UI

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

Property	Type	Description
`type`	`string`	The type of the module.
issue: `id`	`string`	The id of the issue on which the module is rendered.
issue: `key`	`string`	The key of the issue on which the module is rendered.
issue: `type`	`string`	The type of the issue on which the module is rendered.
issue: `typeId`	`string`	The id of the type of the issue on which the module is rendered.
project: `id`	`string`	The id of the project where the module is rendered.
project: `key`	`string`	The key of the project where the module is rendered.
project: `type`	`string`	The type of the project where the module is rendered.

UI kit

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

Extension context

Property	Type	Description
`type`	`string`	The type of the module.

Platform context

Property	Type/value	Description
`issueId`	`string`	The ID of the issue on which the module is rendered.
`issueKey`	`string`	The key of the issue on which the module is rendered.
`issueType`	`string`	The type of the issue on which the module is rendered.
`issueTypeId`	`string`	The ID of the type of the issue on which the module is rendered.
`projectId`	`string`	The ID of the project where the module is rendered.
`projectKey`	`string`	The key of the project where the module is rendered.
`projectType`	`string`	The type of the project where which the module is rendered.

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
    }]
}

Property	Description
`issueId`	ID of the issue the app is rendered on.
`projectId`	ID of the project the issue belongs to.
`changes`	List of issue changes `changeType` - type of the change `commented` - a comment has been added to the page `updated` - the issue has been updated `atlassianId` - ID of the user who made the change

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.