Rate this 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.
See the SpacePage component documentation for an example. When adding this to your app, use it as a top-level component.
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 | The space page module requires either a function for usage with the UI kit, or a resource when building with custom UI. | A reference to the function module that defines the Confluence space page app. |
resource | string | A reference to the static resources entry that your Confluence space page app wants to display. 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. | |
title | string | Yes | The title of the space page app, displayed as a link title. |
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 space page module must have a distinct Regex: |
keyboardShortcut | object | The object that defines a keyboard shortcut to go to this page. See keyboard shortcuts. |
Property | Type | Description |
---|---|---|
type | string | The type of the module. |
Property | Type | Description |
---|---|---|
type | string | The type of the module. |
Rate this page: