Forge Developer

Beta

Forge Developer

Beta

Rate this page:

SpaceSettings

The SpaceSettings component renders content in a tab inside the integration settings of a Confluence space. SpaceSettings is the top-level component required for the confluence:spaceSettings module.

This module can only be used in Confluence.

Usage

1
import ForgeUI, { SpaceSettings } from '@forge/ui';

Props

NameTypeRequiredDescription
childrenArray<ForgeComponent>YesA container for displaying multiple components. Can contain any UI kit component.

Example

A hello world example of the SpaceSettings component.

1
2
3
4
5
6
7
8
9
10
11
12
13
import ForgeUI, {render, Text, SpaceSettings} from '@forge/ui';

const App = () => {
    return (
        <Text>Hello world!</Text>
    );
};

export const run = render(
    <SpaceSettings>
        <App/>
    </SpaceSettings>
);

Preview

Example of a Space settings with the above sample code

Rate this page: