Modules
Display conditions

Rate this page:

Confluence context menu

The confluence:contextMenu module displays an entry in the context menu when a user selects some text on a page or blog. All modules are grouped under the dropdown button in the menu. The title of the module renders as a menu item. When a user clicks the context menu item, the Forge app renders in an inline dialog.

The selected text is passed to the Forge app as a part of extensionContext, and is retrieved using the useProductContext hook. In the app, the ContextMenu should be used along with InlineDialog UI kit components. See the Dictionary app for an example.

Properties

PropertyTypeRequiredDescription
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_-]+$

functionstringThe context menu 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 context menu app.
resourcestringA reference to the static resources entry that your context menu 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' or 'large'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 context menu app, displayed as a menu item.
descriptionstringThe description of the context menu app.

Extension context

Custom UI

PropertyTypeDescription
typestringThe type of the module.
selectedTextstringThe text selected on a page or a blog for which context menu is opened.

UI kit

PropertyTypeDescription
typestringThe type of the module.
selectedTextstringThe text selected on a page or a blog for which context menu is opened.

Rate this page: