Display conditions
Modules

Rate this page:

Confluence global page

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.

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 Confluence global page app.
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.
routestringYes

A string of text that makes the URL of the browser more readable. Inside an app, each global page module must have a distinct route.

Regex: ^[0-9a-z-]+$

displayConditionsobjectThe object that defines whether or not 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: