Forge Developer

Beta

Forge Developer

Beta

Rate this page:

GlobalSettings

The GlobalSettings component renders a full page app in Confluence global settings. GlobalSettings is the top-level component required for the confluence:globalSettings module.

This module can only be used in Confluence.

Usage

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

Props

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

Example

A hello world example of the GlobalSettings component.

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

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


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

Preview

Example of a Global settings with the above sample code

Rate this page: