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.
For UI Kit 1, see the HomepageFeed 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.
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 | Required if using UI Kit 1. | A reference to the function module that defines the module. Only used in UI Kit 1. |
resource | string | Required if using custom UI or the current 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 } | Yes | 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 | Yes | The title of the homepage feed app, displayed as a section title. |
description | string | The description of the homepage feed app. | |
keyboardShortcut | object | The object that defines a keyboard shortcut to toggle this module. See keyboard shortcuts. |
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. |
Property | Type | Description |
---|---|---|
type | string | The type of the module. |
Rate this page: