Forge Developer

Beta

Forge Developer

Beta

Rate this page:

IssueGlance

The IssueGlance component renders content that is shown/hidden in an issue by clicking a button. The button for the issue glance is placed alongside fields such as Assignee and Labels. Clicking the button renders the children content in the right sidebar. IssueGlance is the top-level component required for the jira:issueGlance module.

This module can be used in Jira Core, Jira Software, and Jira Service Desk. It works in the new issue view but not the old issue view.

Usage

1
import ForgeUI, { IssueGlance } from '@forge/ui';

Props

NameTypeRequiredDescription
childrenArray<ForgeComponent>YesA container for displaying multiple components. Can contain any UI kit component.

Example

A hello world example of the issue glance.

1
2
3
4
5
6
7
8
9
10
11
import ForgeUI, { render, IssueGlance, Text } from "@forge/ui";

const App = () => {
  return <Text>Hello from the Issue glance!</Text>;
};

export const run = render(
  <IssueGlance>
    <App />
  </IssueGlance>
);

Preview

Displays the button to launch the glance (1) and the glance content (2).

Example of an Issue glance with the above sample code Example of an open Issue glance with the above sample code

Rate this page: