Display conditions
Modules

Rate this page:

Jira global page

The jira:globalPage module adds an item in the Apps section of the main navigation. You can use the UI kit or custom UI to create content for the page.

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

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

Subpages

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.

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 global page module requires a function for use with the UI kit or a resource when building with custom UI.A reference to the function module that defines the global page. This function must return the globalPage component.
resourcestringA reference to the static resources entry that the global page displays. 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.
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.
layoutnative|basic (default: native)The layout of the global page that defines whether a page is rendered with default controls (native) or lays out the entire viewport (basic).
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.

Page

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

Section

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

Extension context

Custom UI

PropertyTypeDescription
typestringThe type of the module.

UI kit

PropertyTypeDescription
typestringThe type of the module.

Rate this page: