Confluence full page apps are now available through Forge's Early Access Program (EAP). View the announcement for more information. You can sign up here start testing this feature.
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.
The confluence:fullPage
module lets you to create fully customised app experiences within Confluence Cloud.
Full page apps occupy the entire web page, providing ample space to deliver UI for a broader range of use cases,
such as specialised content views or internal tools that reflect your own branding.
Full page apps can be accessed from the browser address bar in the format: /full-page/:appId/:forgeEnvId
.
To deploy apps containing confluence:fullPage
modules during this EAP, you can utilise the --no-verify
option
with the Forge CLI deploy
command to avoid manifest validation errors.
Many features exposed by the Forge bridge SDKs have not been made available during the EAP. Review the linked announcement and share your feedback on features you’d like to see in future releases. Your input will help us prioritise features that matter most to you.
1 2modules [] └─ confluence:fullPage {} ├─ key (string) [Mandatory] ├─ resource (string) [Mandatory] ├─ render (string) [Optional] └─ resolver {} [Optional] resources [] ├─ key (string) [Mandatory] └─ path (string) [Mandatory]
Property | Type | Required | Description |
---|---|---|---|
key |
| Yes |
A key for the module, which other modules can refer to. Must be unique within the manifest. Regex: |
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 Set the |
Key | Type | Required | Description |
---|---|---|---|
i18n | string | Yes | A key referencing a translated string in the translation files. For more details, see Translations. |
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. |
location | string | The full URL of the host page where this module is displayed. |
This example shows you how to create a simple UI kit app that spans the entire page.
1 2modules: confluence:fullPage: - key: hello-full-page-app resource: main
1 2import React, { useState } from "react"; import ForgeReconciler, { Box, Text, xcss } from "@forge/react"; const boxStyle = xcss({ backgroundColor: "color.background.accent.yellow.subtle", }); const App = () => { return ( <Box xcss={boxStyle}> <Text>My full page app!</Text> </Box> ); }; ForgeReconciler.render( <React.StrictMode> <App /> </React.StrictMode> );
Rate this page: