Rate this page:
This module now has support for UI Kit 2 (preview) for faster user experiences and to access additional React features.
For more information on all the supported modules, see the Supported products and their modules section.
The jira:issueAction
module adds a menu item to the more actions (•••) menu on the issue view.
When the menu item is clicked, the module’s function renders a modal dialog.
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 IssueAction
component documentation for more information. This is an example of an IssueAction
button:
This is an example of the triggered modal dialog:
Property | Type | Required | Description |
---|---|---|---|
key |
| Yes | A key for the module, which other modules can refer to. Must be unique within the manifest.
Regex: |
function | string | The issue action 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 action. This function must return the IssueAction component, which renders the modal dialog for its content. |
resource | string | A reference to the static resources entry that your issue action 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. | |
viewportSize | 'small' , 'medium' , 'large' or 'xlarge' | The display size of resource . Can only be set if the module is using the resource property. Remove this property to enable automatic resizing of the module. | |
title | string | Yes | The title of the issue action, which is displayed as a menu item. |
displayConditions | object | The object that defines whether or not a module is displayed in the UI of the app. See display conditions. |
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. |
Use the useProductContext hook to access the context in UI Kit.
Property | Type | Description |
---|---|---|
type | string | The type of the module. |
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. |
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 2import {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.
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
|
Rate this page: