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

Jira global page

The jira:globalPage module adds an item in the Apps section of the main navigation.

The page URL is constructed in the following format: /jira/apps/{appId}/{envId}

For UI Kit 1, see the GlobalPage component documentation for an example. When adding this to your app, use it as a top-level component.

Example of a global page


By default, the jira:globalPage module registers a top-level page. However, there is an option to register multiple pages using a pages or sections field.

Use pages to add individual pages to the sidebar and sections to group pages.

The sidebar will only change the global page URL, you will need to handle routes inside your custom UI app using view.createHistory().

This feature works only with custom UI.

Manifest example

    - key: hello-world-global-page
      resource: main
        function: resolver
      render: native
      title: Hello World!





A key for the module, which other modules can refer to. Must be unique within the manifest.

Regex: ^[a-zA-Z0-9_-]+$

functionstringRequired if using UI Kit 1.A reference to the function module that defines the module. Only used in UI Kit 1.
resourcestringRequired if using custom UI or the latest version of UI Kit.A reference to the static resources entry that your context menu app wants to display. See resources for more details.
render'native'Yes for UI Kit.Indicates the module uses UI Kit.
resolver{ function: string } or
{ endpoint: string }

Set the function property if you are using a hosted function module for your resolver.

Set the endpoint property if you are using Forge remote to integrate with a remote back end.

titlestringYesThe title of the global page, which is displayed at the top of the page.
iconstringThe URL of the icon that displays next to the title. Relative URL's aren't supported. A generic app icon is displayed if no URL is provided.
layout UI Kit:
  • native
  • basic
Custom UI:
  • native
  • blank
  • basic (deprecated)
(default: native)
The layout of the global page that defines whether a page is rendered with default controls (native), lays out the entire viewport with a margin on the left and breadcrumbs (basic for UI Kit), or is left blank allowing for full customization (blank for custom UI).
pagesPage[]You can only specify `pages` or `sections` but not both.The list of subpages to render on the sidebar.
sectionsSection[]The list of sections to render on the sidebar.
displayConditionsobjectThe object that defines whether a module is displayed in the UI of the app. See display conditions.


titlestringYesThe title of the subpage, which is displayed on the sidebar.
iconstringThe URL of the icon that's displayed next to the subpage title. A generic app icon is displayed if no icon is provided.
routestringYesThe unique identifier of the subpage. This identifier is appended to the global page URL.


headerstringThe section header.
pagesPage[]YesThe list of subpages to render on the sidebar.

Extension data

UI Kit and Custom UI

Use the useProductContext hook to access the extension context in UI Kit or getContext bridge method in custom UI.

typestringThe type of the module.

UI Kit 1

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

Extension context

typestringThe type of the module.

Rate this page: