The confluence:homepageFeed
module displays content in the right panel of the Confluence Home page.
Each module represents a separate section in the panel, and the title
of each module is used as a section title. When a user clicks an app title, the corresponding section is expanded, and the Forge app is rendered as content.
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.
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: |
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. |
resolver | { function: string } or{ endpoint: string } |
Set the Set the | |
viewportSize | 'small' , 'medium' , 'large' or 'xlarge' | The display size of resource . Can only be set if the module is using the resource property. Remove this property to enable automatic resizing of the module. | |
title | string or i18n object | Yes |
The title of the homepage feed app, displayed as a section title. The |
keyboardShortcut | object | The object that defines a keyboard shortcut to toggle this module. See keyboard shortcuts. |
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. |
Rate this page: