Bitbucket modules (EAP)
Common modules
Compass modules
Confluence modules
Jira modules
Jira Service Management modules

Rate this page:

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.

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

Example of a Global settings with the above sample code

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.
render'native'Yes for UI Kit 2Indicates if the module is a UI Kit 2 module.
resolver{ function: string } or
{ endpoint: string }

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.

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.
displayConditionsobjectThe object that defines whether or not a module is displayed in the UI of the app. See display conditions.
useAsConfigbooleanIndicates whether this global settings module will be used as the app's Configure page. If set to true, a link to this page will be shown within the app section on the Manage Apps page. Use this page to provide primary app configuration/settings to the admin. Only one global settings module can be specified as the Configure page per app. Related: Configuring apps.

Note: modules which use this property will not have a link in the navigation menu as is the case with standard confluence:globalSettings modules.
useAsGetStartedbooleanIndicates whether this global settings module will be used as the app's Get Started page. If set to true, a link to this page will be shown within the app section on the Manage Apps page and from the dialog shown when an admin successfully installs the app. Use this page to provide introductory information about the app to the admin. Only one global settings module can be specified as the Get Started page per app. Related: Manage Your Apps.

Note: modules which use this property will not have a link in the navigation menu as is the case with standard confluence:globalSettings modules.
keyboardShortcutobjectThe object that defines a keyboard shortcut to go to this page. See keyboard shortcuts.

Extension context

Custom UI

PropertyTypeDescription
typestringThe type of the module.

UI kit

PropertyTypeDescription
typestringThe type of the module.

Rate this page: