Rate this page:
The macro
module inserts dynamic content into the user interface via an editor. Editor macros are
only compatible with the Atlassian editor. All cloud sites use the Atlassian editor by default.
The macro
module works in Confluence, where the macro is inserted by typing "/" and selecting
from the quick insert menu of the editor. The macro
module is implemented by a Forge function.
See the Macro component documentation for an example.
Property | Type | Required | Description |
---|---|---|---|
key |
| Yes |
A key for the module, which other modules can refer to. Must be unique within the manifest. Regex: |
function | string | The macro 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 macro. |
resource | string | A reference to the static resources entry that your macro 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' , '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 macro. In Confluence, this is displayed in the editor. |
description | string | The description of the macro. In Confluence, this is displayed in the editor. | |
config | { function: string } | Contains a function property, which references the function module that defines the macro configuration. |
Rate this page: