Skip to content

Modules Reference

This page contains a list of all the App Maker UI modules and instructions on how to use them.

jira:issueContext

  • The "jira:issueContext" module is used to place a small card in the sidebar on the right-hand side of the Jira Issue view.
  • All the Apps configured to show in this Module will be displayed in a vertical stack in the sidebar.
  • This module requires a "StackedInformationGroup" component as the top-level component of any Apps placed within it.

Jira Issue Context

jira:issuePanel

  • The "jira:issuePanel" module is used to place a full-width panel below the "Description" section of the Jira Issue view.
  • This panel is activated by clicking the "Custom Apps" button at the top of the Issue view.
  • Each of the Apps configured to show in this Module will be displayed in a separate tab in the Issue Panel.
  • This module requires a "TabPanel" component as the top-level component of any Apps placed within it.

Jira Issue Panel

jira:issueActivity

  • The "jira:issueActivity" module is used to place a full-width panel in the "Activity" area of the Jira Issue view.
  • This panel is activated by clicking the "Custom Apps" button in the "Show:" list.
  • Each of the Apps configured to show in this Module will be displayed in a separate tab in the Issue Panel.
  • This module requires a "TabPanel" component as the top-level component of any Apps placed within it.

Jira Issue Activity

jira:issueAction

  • The "jira:issueAction" module is used to place an App into the Issue Action dialog window.
  • This dialog is activated by clicking the "Custom Apps" button in the 'Three Dots' menu in the top-right of the Jira Issue view.
  • Each of the Apps configured to show in this Module will be displayed in a separate tab in the Issue Action dialog.
  • This module requires a "TabPanel" component as the top-level component of any Apps placed within it.

Jira Issue Action Menu

Jira Issue Action

jira:projectSettingsPage

  • The "jira:projectSettingsPage" module is used to add a full-page app into the Settings area of a Jira project.

  • This page is accessed by clicking the "Custom Apps" button the sidebar on the left side of the Project settings area.

  • Each of the Apps configured to show in this Module will be displayed in a separate tab in the Custom Apps page.

  • This module requires a "TabPanel" component as the top-level component of any Apps placed within it.

  • Jira Project Settings

jira:adminPage

  • The "jira:adminPage" module is used to add a full-page app into the site-wide Admin area of a Jira site.
  • To access this area of the product, click the cog icon in the top-right of the page, and then click "Apps" in the "JIRA SETTINGS" section of the dropdown menu.
  • Then, select the "Custom Apps" option in the sidebar on the left side of the page.
  • Each of the Apps configured to show in this Module will be displayed in a separate tab in the Custom Apps page.
  • This module requires a "TabPanel" component as the top-level component of any Apps placed within it.

Jira Admin Page