Bitbucket modules
Common modules
Compass modules
Confluence modules
Jira modules
Jira Service Management modules

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 space settings

The confluence:spaceSettings module adds a tab inside the integration settings of a Confluence space. Clicking the tab shows the module's content.

See the SpaceSettings component documentation for an example.

Example of the Space settings component

The page URL is constructed in the form of: /spaces/:spaceKey/settings/apps/:appId/:envId/:route. You can configure :route in the manifest.

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 space 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 space settings app.
resourcestringA reference to the static resources entry that your Confluence space 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 }
Yes

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 space settings, which is displayed as the title of the tab.
routestring Yes (Effective starting 15 May, 2024)

A string of text that makes the URL of the browser more readable. Inside an app, each space settings module must have a distinct route.

Regex: ^[0-9a-z-]+$

displayConditionsobjectThe object that defines whether or not a module is displayed in the UI of the app. See display conditions.
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: