Common modules
Compass modules
Confluence modules
Jira modules
Jira Service Management modules

Rate this page:

Jira issue panel

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.

Example of an Issue panel

Properties

PropertyTypeRequiredDescription
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_-]+$

functionstringThe 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.
resourcestringA 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.
titlestringYesThe 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.
iconstringYesThe absolute URL of the icon that will be displayed as a button. Relative URLs aren't supported. When the button is clicked, an issue panel is added to the issue view.
allowMultiple

boolean

Controls whether or not multiple instances of the issue panel are shown when clicking the issue panel button repeatedly. Defaults to false.

If set to true, a maximum number of five instances of the issue panel can be shown on the issue.

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

PropertyTypeDescription
typestringThe type of the module.
issue:
  id
stringThe id of the issue on which the module is rendered.
issue:
  key
stringThe key of the issue on which the module is rendered.
issue:
  type
stringThe type of the issue on which the module is rendered.
issue:
  typeId
stringThe id of the type of the issue on which the module is rendered.
project:
  id
stringThe id of the project where the module is rendered.
project:
  key
stringThe key of the project where the module is rendered.
project:
  type
stringThe type of the project where the module is rendered.
isNewToIssuebooleanDefines if the panel was just added to the issue.

UI kit

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

Extension context

PropertyTypeDescription
typestringThe type of the module.

Platform context

PropertyType/valueDescription
issueIdstringThe ID of the issue on which the module is rendered.
issueKeystringThe key of the issue on which the module is rendered.
issueTypestringThe type of the issue on which the module is rendered.
issueTypeIdstringThe ID of the type of the issue on which the module is rendered.
projectIdstringThe ID of the project where the module is rendered.
projectKeystringThe key of the project where the module is rendered.
projectTypestringThe type of the project where which the module is rendered.
isNewToIssuebooleanDefines if the panel was just added to the issue.

Rate this page: