Modules
Display conditions

Rate this page:

Confluence global settings

The confluence:globalSettings module adds a link to the left navigation menu in Confluence global settings. Clicking the link shows the module's content. You can use the storage API with the confluence:globalSettings to store Confluence global settings in your Forge app storage. See the GlobalSettings component documentation 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 global settings 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 Confluence global settings app.
resourcestringA reference to the static resources entry that your Confluence global settings 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.
titlestringYesThe title of the global settings, which is displayed as the title of the link and header of the page.

Extension context

Custom UI

PropertyTypeDescription
typestringThe type of the module.

UI kit

PropertyTypeDescription
typestringThe type of the module.

Rate this page: