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.

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.

Example of a SpacePage component

Properties

Property	Type	Required	Description
`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_-]+$`
`resource`	`string`	If using Custom UI or modern versions of UI Kit	The key of a static `resources` entry that your module will display. See resources for more details.
`render`	`'native'`	If using modern versions of UI Kit	Indicates the module uses UI Kit.
`function`	`string`	Deprecated Required if using UI Kit 1	The key of a function module that returns a UI Kit 1 component.
`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.
`title`	`string` or `i18n object`	Yes	The title of the space page app, displayed as a link title. The `i18n object` allows for translation and is available to participants of the Internationalization for Forge EAP. See i18n object.
`icon`	`string`		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.
`route`	`string`	Yes	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-]+$`
`keyboardShortcut`	`object`		The object that defines a keyboard shortcut to go to this page. See keyboard shortcuts.

i18n object

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.

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.

Property	Type	Description
`type`	`string`	The type of the module.
`space.id`	`string`	A string that represents the unique identifier of the `space` object.
`space.key`	`string`	A string that represents the unique key of the `space` object.

UI Kit 1

Property	Type	Description
`type`	`string`	The type of the module.