ViewIssueModal

On This Page

Class signature
Arguments
Example
Supported modules

The ViewIssueModal class enables your UI Kit and custom UI app to open the issue view modal for an issue.

Class signature

1
2
3
4
5
6
7
8
9
10
11
interface ViewIssueModalOptions {
  context: {
    issueKey: string;
  };
  onClose?: () => void;
}

class ViewIssueModal {
  constructor(opts: ViewIssueModalOptions);
  open(): Promise<void>;
}

Arguments

onClose: A callback function that runs when the issue view modal is closed.
context: Custom context that contains the key of the issue to open.

Example

This example shows how to open an issue view modal.

1
2
import { ViewIssueModal } from '@forge/jira-bridge';

const viewIssueModal = new ViewIssueModal({
  onClose: () => {
    console.log('ViewIssueModal closed');
  },
  context: {
    issueKey: 'CS-15',
  },
});

viewIssueModal.open();

Supported modules

ViewIssueModal can be used in these modules:

Jira admin page

Add an item to the Apps section of the left navigation in Jira admin settings.

Jira backlog action

Add a menu item to the more actions (•••) menu on the backlog view.

Jira board action

Add a menu item to the more actions (•••) menu on the board view.

Jira dashboard gadget

Create a dashboard gadget displayed on the Dashboards page.

Jira global page

Add an item to the Apps section of the main navigation that opens as a full-page.

Jira issue navigator action

Add a menu item to the apps menu on the issue navigator view.

Jira personal settings page

Use the Jira personal settings page module to create a page where users can change their personal settings related to your app.

Jira project page

Add an custom project page to enhance project navigation and access.

Jira project settings page

Add an item to the project settings sidebar.

Jira sprint action

Add a menu item to the actions (•••) menu on a sprint card in the backlog view.

Jira UI modifications

Modify the Jira UI using the UI modifications APIs.