Display conditions
Modules

Rate this page:

Jira global page

The jira:globalPage module adds an item in the Apps section of the main navigation. Use the UI kit or custom UI to create content for the page. When using the UI kit in an app, use the GlobalPage component as a top-level component.

The page URL is constructed in the form of: /jira/apps/{appId}/{envId}

This module can be used in Jira Core, Jira Software, and Jira Service Management.

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. 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).
displayConditionsobjectThe object that defines whether a module is displayed in the UI of the app. See display conditions.

Extension context

Custom UI

PropertyTypeDescription
typestringThe type of the module.

UI kit

PropertyTypeDescription
typestringThe type of the module.

Rate this page: