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.

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

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 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.

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.