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.
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.
1 2modules: jira:globalPage: - key: hello-world-global-page resource: main resolver: function: resolver render: native title: Hello World!
Property | Type | Required | Description |
---|---|---|---|
key |
| Yes |
A key for the module, which other modules can refer to. Must be unique within the manifest. Regex: |
function | string | Required if using UI Kit 1. | A reference to the function module that defines the module. Only used in UI Kit 1. |
resource | string | Required 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 } | Yes | Set the Set the |
title | string or i18n object | Yes |
The title of the global page, which is displayed at the top of the page. The |
icon | string | The 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 )
| 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). | |
pages | Page[] | You can only specify `pages` or `sections` but not both. | The list of subpages to render on the sidebar. |
sections | Section[] | The list of sections to render on the sidebar. | |
displayConditions | object | The object that defines whether a module is displayed in the UI of the app. See display conditions. |
Internationalization (i18n) for Forge apps is now available through Forge's Early Access Program (EAP). For details on how to sign up for the EAP, see the changelog announcement.
EAPs are offered to selected users for testing and feedback purposes. APIs and features under EAP are unsupported and subject to change without notice. APIs and features under EAP are not recommended for use in production environments.
For more details, see Forge EAP, Preview, and GA.
Key | Type | Required | Description |
---|---|---|---|
i18n | string | Yes | A key referencing a translated string in the translation files. For more details, see Translations. |
Property | Type | Required | Description |
---|---|---|---|
title | string or i18n object | Yes |
The title of the subpage, which is displayed on the sidebar. The |
icon | string | The URL of the icon that's displayed next to the subpage title. A generic app icon is displayed if no icon is provided. | |
route | string | Yes | The unique identifier of the subpage. This identifier is appended to the global page URL. |
Property | Type | Required | Description |
---|---|---|---|
header | string or i18n object |
The section header. The | |
pages | Page[] | Yes | The list of subpages to render on the sidebar. |
Use the useProductContext hook to access the extension context in UI Kit or getContext bridge method in custom UI.
Property | Type | Description |
---|---|---|
type | string | The type of the module. |
Use the useProductContext hook to access the context in UI Kit 1.
Property | Type | Description |
---|---|---|
type | string | The type of the module. |
Rate this page: