Rate this page:
The jira:issuePanel
module adds an issue panel to a Jira issue when a configured button is clicked.
The content of the module is shown above the Activity panel on a Jira issue.
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 IssuePanel component documentation for more details.
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 panel 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 panel. This function must return the IssuePanel component. |
resource | string | A reference to the static resources entry that your issue 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. | |
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 panel, which is displayed above the panel. The title also appears in the ••• menu that’s clicked to display the issue panel. |
icon | string | Yes |
The icon that will be displayed as a button. When the button is clicked, an issue panel is added to the issue view. For custom UI and UI kit apps, the If no icon is provided, or if there's an issue preventing the icon from loading, a generic app icon will be displayed. |
allowMultiple |
|
Controls whether or not multiple instances of the issue panel are shown when clicking the issue panel button repeatedly. Defaults to If set to | |
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. |
isNewToIssue | boolean | Defines if the panel was just added to the issue. |
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. |
isNewToIssue | boolean | Defines if the panel was just added to the issue. |
Rate this page: