The confluence:globalPage
module displays content in place of a Confluence page. Each module appears as a link in
the main navigation menu in Apps section, and the title of each module is used as the title of the link.
When a user clicks a link, the corresponding Forge app renders inside the main content area of Confluence.
The page URL is constructed in the form of: /apps/:appId/:forgeEnvId/:route
. You can configure :route
in the manifest.
For UI Kit 1, see the GlobalPage component documentation for more information. When adding this to your app, use it as a top-level component.
On apps that use Custom UI, module content is displayed inside a special Forge iframe which has the sandbox attribute configured. This means that HTML links (for example, <a href="https://domain.tld/path">...</a>
) in this iframe won't be clickable. To make them clickable, use the router.navigate API from the @forge/bridge
package.
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 current 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 | Yes | The title of the global page, which is displayed at the top of the page. |
icon | string |
The icon displayed next to the For custom UI and UI Kit apps, the If no icon is provided, or if there's an issue preventing the icon from loading, a generic app icon will be displayed. | |
route | string | Yes |
A string of text that makes the URL of the browser more readable. Inside an app, each global page module must have a distinct Regex: |
displayConditions | object | The object that defines whether or not a module is displayed in the UI of the app. See display conditions. | |
keyboardShortcut | object | The object that defines a keyboard shortcut to go to this page. See keyboard shortcuts. |
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. |
Property | Type | Description |
---|---|---|
type | string | The type of the module. |
Rate this page: