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.
The confluence:contentAction
module adds a menu item to the more actions (•••) menu for pages and
blogs. When the menu item is clicked, the module’s function renders a modal dialog.
For UI Kit 1, see the ContentAction component documentation for more information.
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.
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 latest 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 content action, which is displayed as a menu item. |
displayConditions | object | The object that defines whether or not a module is displayed in the UI of the app. See display conditions. | |
keyboardShortcut | object | The object that defines a keyboard shortcut to trigger 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. |
content.id | string | A string that represents the unique identifier of the `content` object |
space.id | string | A string that represents the unique identifier of the `space` object. |
space.key | string | A string that represents the unique key of the `space` object. |
Property | Type | Description |
---|---|---|
type | string | The type of the module. |
Rate this page: