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.

For UI Kit 1, see the SpaceSettings component documentation for an example. 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 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

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_-]+$`
`function`	`string`	Required if using UI Kit 1.	A reference to the function module that defines the module. Only used in UI Kit 1.
`resource`	`string`	Required if using custom UI or the current 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 `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.
`title`	`string`	Yes	The title of the space settings, which is displayed as the title of the tab.
`route`	`string`	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-]+$`
`displayConditions`	`object`		The object that defines whether or not a module is displayed in the UI of the app. See display conditions.
`keyboardShortcut`	`object`		The object that defines a keyboard shortcut to go to this page. See keyboard shortcuts.

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.
`space.id`	`string`	A string that represents the unique identifier of the `space` object.
`space.key`	`string`	A string that represents the unique key of the `space` object.

UI Kit 1

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