Confluence context menu

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:contextMenu module displays an entry in the context menu when a user selects some text on a page or blog. The title in each confluence:contextMenu module section (from every installed app's manifest file) will render as a separate menu item under the dropdown menu. 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.

See the ContextMenu component documentation for an example.

When adding the confluence:contextMenu module to your app, use it along with the InlineDialog UI kit component.

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 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.
`resource`	`string`		A 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.
`title`	`string`	Yes	The title of the context menu module, displayed as a menu item.
`description`	`string`		The description of the context menu app.
`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.
`selectedText`	`string`	The text selected on a page or a blog for which context menu is opened.

UI kit

Property	Type	Description
`type`	`string`	The type of the module.
`selectedText`	`string`	The text selected on a page or a blog for which context menu is opened.