Jira issue action

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.

For UI Kit 1, see the IssueAction component documentation for more information. This is an example of an IssueAction button:

Example of an Issue action button

This is an example of the triggered modal dialog:

Example of an Issue action with the above sample code

Manifest example

1
2
modules:
  jira:issueAction:
    - key: hello-world-issue-action
      resource: main
      resolver:
        function: resolver
      render: native
      title: Hello World

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_-]+$`
`resource`	`string`	If using Custom UI or modern versions of UI Kit	The key of a static `resources` entry that your module will display. See resources for more details.
`render`	`'native'`	If using modern versions of UI Kit	Indicates the module uses UI Kit.
`function`	`string`	Deprecated Required if using UI Kit 1	The key of a function module that returns a UI Kit 1 component.
`resolver`	`{ function: string }` or `{ endpoint: string }`		Set the `function` property if you are using a hosted `function` module for your resolver. Set the `endpoint` property if you are using Forge remote to integrate with a remote back end.
`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` or `i18n object`	Yes	The title of the issue action, which is displayed as a menu item. The `i18n object` allows for translation and is available to participants of the Internationalization for Forge EAP. See i18n object.
`displayConditions`	`object`		The object that defines whether or not a module is displayed in the UI of the app. See display conditions.

i18n object

Internationalization (i18n) for Forge apps is now available through Forge's Early Access Program (EAP). For details on how to sign up for the EAP, see the changelog announcement.

EAPs are offered to selected users for testing and feedback purposes. APIs and features under EAP are unsupported and subject to change without notice. APIs and features under EAP are not recommended for use in production environments.

For more details, see Forge EAP, Preview, and GA.

Key	Type	Required	Description
`i18n`	`string`	Yes	A key referencing a translated string in the translation files. For more details, see Translations.

Extension data

UI Kit and Custom UI

Use the useProductContext hook to access the extension context in UI Kit or getContext bridge method 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 1

Use the useProductContext hook to access the context in UI Kit 1.

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.