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.
Properties
| 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 | Required if using UI Kit 1 or triggers. | A reference to the function module that defines the module. |
resource | string | Required if using custom UI or the latest 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 Set the |
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 |
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
Internationalization (i18n) for Forge apps is now available through Forge's Early Access Program (EAP). For details on how to sign up for the EAP, see the changelog announcement.
EAPs are offered to selected users for testing and feedback purposes. APIs and features under EAP are unsupported and subject to change without notice. APIs and features under EAP are not recommended for use in production environments.
For more details, see Forge EAP, Preview, and GA.
| 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. |
Rate this page: