Bitbucket modules
Common modules
Compass modules
Confluence modules
Jira modules
Jira Service Management modules

Confluence space page

The confluence:spacePage module displays content in place of a Confluence page. Each module appears as a link in the space navigation menu, 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 content area of Confluence.

The URL is updated with the following app information in the form of: /spaces/:spaceKey/apps/:appId/:forgeEnvId/:route. You can configure :route in the manifest.

For UI Kit 1, see the SpacePage component documentation for an example. When adding this to your app, use it as a top-level component.

Example of a SpacePage component





A key for the module, which other modules can refer to. Must be unique within the manifest.

Regex: ^[a-zA-Z0-9_-]+$

functionstringRequired if using UI Kit 1.A reference to the function module that defines the module. Only used in UI Kit 1.
resourcestringRequired 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 }

Set the function property if you are using a hosted function module for your resolver.

Set the endpoint property if you are using Forge remote to integrate with a remote back end.

titlestringYesThe title of the space page app, displayed as a link title.

The icon displayed next to the title.

For custom UI and UI Kit apps, the icon property accepts a relative path from a declared resource. Alternatively, you can also use an absolute URL to a self-hosted icon. See Icons for more information.

If no icon is provided, or if there's an issue preventing the icon from loading, a generic app icon will be displayed.


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

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

keyboardShortcutobjectThe object that defines a keyboard shortcut to go to this page. See keyboard shortcuts.

Extension context

UI Kit and Custom UI

Use the useProductContext hook to access the extension context in UI Kit or getContext bridge method in custom UI.

typestringThe type of the module.
space.idstringA string that represents the unique identifier of the `space` object.
space.keystringA string that represents the unique key of the `space` object.

UI Kit 1

typestringThe type of the module.

Rate this page: