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. 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.

For UI Kit 1, see the ContextMenu component documentation for an example.

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.

When adding the confluence:contextMenu module to your app, use it along with the InlineDialog UI Kit 1 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`	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 current 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 `function` property if you are using a hosted `function` module for your resolver. Set the `endpoint` property if you are using Forge remote (preview) to integrate with a remote back end.
`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

UI Kit and Custom UI

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.
`selectedText`	`string`	The text selected on a page or a blog for which context menu is opened.
`content.id`	`string`	A string that represents the unique identifier of the `content` object
`content.type`	`string`	A string that represents the unique key 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.

UI Kit 1

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