Rate this page:
This module now has support for UI Kit 2 (preview) for faster user experiences and to access additional React features.
For more information on all the supported modules, see the Supported products and their modules section.
Confluence homepage feed
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.
See the HomepageFeed component documentation for an example.
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.
Properties
| 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 homepage feed 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 homepage feed app. |
resource | string | A reference to the static resources entry that your Confluence homepage feed 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. | |
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. |
Extension context
Custom UI
| Property | Type | Description |
|---|---|---|
type | string | The type of the module. |
UI kit
| Property | Type | Description |
|---|---|---|
type | string | The type of the module. |
Rate this page: