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.

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.

Example of a Content action button

Example of a Content action with the above sample code

Properties

Property	Type	Required	Description
`key`	`string`	Yes	A key for the module, which other modules can refer to. Must be unique within the manifest. Regex: `^[a-zA-Z0-9_-]+$`
`function`	`string`	The content action 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 content action. This function must return the ContentAction component, which renders the modal dialog for its content.
`resource`	`string`		A reference to the static `resources` entry that your content action wants to display. See resources for more details.
`render`	`'native'`	Yes for UI Kit 2	Indicates if the module is a UI Kit 2 module.
`resolver`	`{ function: string }` or `{ endpoint: string }`	Yes	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 backend. 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 content action, which is displayed as a menu item.
`description`	`string`		The description of the content action.
`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.

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.