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.

For UI Kit 1, see the GlobalSettings component documentation for more information. When adding this to your app, use it as a top-level component.

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.

Example of a Global settings with the above sample code

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_-]+$`
`resource`	`string`	If using Custom UI or modern versions of UI Kit	The key of a static `resources` entry that your module will display. See resources for more details.
`render`	`'native'`	If using modern versions of UI Kit	Indicates the module uses UI Kit.
`function`	`string`	Deprecated Required if using UI Kit 1	The key of a function module that returns a UI Kit 1 component.
`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 to integrate with a remote back end.
`title`	`string` or `i18n object`	Yes	The title of the global settings, which is displayed as the title of the link and header of the page. The `i18n object` allows for translation. See i18n object.
`displayConditions`	`object`		The object that defines whether or not a module is displayed in the UI of the app. See display conditions.
`useAsConfig`	`boolean`		Indicates 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.
`useAsGetStarted`	`boolean`		Indicates 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.
`keyboardShortcut`	`object`		The object that defines a keyboard shortcut to go to this page. See keyboard shortcuts.

i18n object

Key	Type	Required	Description
`i18n`	`string`	Yes	A key referencing a translated string in the translation files. For more details, see Translations.

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.

UI Kit 1

Property	Type	Description
`type`	`string`	The type of the module.