Bitbucket modules
Common modules
Compass modules
Confluence modules
Jira modules
Jira Service Management modules

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 content action

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.

Example of a Content action button

Example of a Content action with the above sample code





A key for the module, which other modules can refer to. Must be unique within the manifest.

Regex: ^[a-zA-Z0-9_-]+$

functionstringRequired if using UI Kit 1.A reference to the function module that defines the module. Only used in UI Kit 1.
resourcestringRequired 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 }

Set the function property if you are using a hosted function module for your resolver.

Set the endpoint property if you are using Forge remote to integrate with a remote back end.

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.
titlestringYesThe title of the content action, which is displayed as a menu item.
descriptionstringThe description of the content action.
displayConditionsobjectThe object that defines whether or not a module is displayed in the UI of the app. See display conditions.
keyboardShortcutobjectThe object that defines a keyboard shortcut to trigger this module. See keyboard shortcuts.

Extension context

UI Kit and Custom UI

Use the useProductContext hook to access the extension context in UI Kit or getContext bridge method in custom UI.

typestringThe type of the module.
content.idstringA string that represents the unique identifier of the `content` object
space.idstringA string that represents the unique identifier of the `space` object.
space.keystringA string that represents the unique key of the `space` object.

UI Kit 1

typestringThe type of the module.

Rate this page: