The full page module allows you to create fully customised app experiences. Full page modules occupy the entire web page, providing ample space to deliver UI for a broader range of use cases, such as specialised content views or internal tools that reflect your own branding.

The global:fullPage module delivers an immersive full-page experience separate from Atlassian core app UIs.

Use the compatibility settings in your app manifest to choose how your app is installed and whether it links to Atlassian apps.

Manifest structure

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
modules []
└─ global:fullPage {}
   ├─ key (string) [Mandatory]
   ├─ resource (string) [Mandatory]
   ├─ routePrefix (string) [Mandatory]
   ├─ render (string) [Mandatory for UI Kit only]
   ├─ resolver {} [Optional]
   ├─ title {} [Optional]
   └─ icon {} [Optional]

resources []
├─ key (string) [Mandatory]
└─ path (string) [Mandatory]

app {}
├─ id (string) [Required]
├─ runtime {} [Required]
└─ compatibility {} [Optional]

Example manifest

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
modules:
  global:fullPage:
    - key: my-app
      resource: main
      routePrefix: route-prefix
      render: native
      resolver:
        function: resolver
      title: My App
      icon: resource:icons;icon.svg
  function:
    - key: resolver
      handler: index.handler
resources:
  - key: main
    path: src/frontend/index.jsx
  - key: icons
    path: icons
app:
  runtime:
    name: nodejs22.x
    memoryMB: 256
    architecture: arm64
  id: ari:cloud:ecosystem::app/your-app-id

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_-]+$`
`resource`	`string`	If using Custom UI or modern versions of UI Kit	The key of a static `resources` entry that your module will display. See resources for more details.
`render`	`'native'`	If using modern versions of UI Kit	Indicates the module uses UI Kit.
`resolver`	`{ function: string }` or `{ endpoint: string }`		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 to integrate with a remote back end.
`routePrefix`	`string`	Yes	Unique route identifier for a module. This serves as the entry point for each module. Within an app, each full page module must have a distinct `routePrefix`. Regex: `^[a-z0-9\\-]+$`
`title`	`string`	No	The title of the full page, which is displayed in the tab title.
`icon`	`string`	No	The icon to use as the favicon for the page. For Custom UI and UI Kit apps, the `icon` property accepts a relative path from a declared resource. See Icons for more information. If no icon is provided, or if there's an issue preventing the icon from loading, a generic app icon will be displayed.

Compatibility

Global modules support the compatibility models described in App compatibility. Choose the model that matches whether your app is installed into an Atlassian app on a site, installed in the unit context, or connected to one or more Atlassian apps.

For an app that is installed into a single Atlassian app on a site, you don't need to declare app.compatibility:

1
2
3
app:
  id: ari:cloud:ecosystem::app/your-app-id

For a Global App installed in the unit context with no Atlassian app links, declare an empty compatibility object:

1
2
3
4
app:
  compatibility: {}
  id: ari:cloud:ecosystem::app/your-app-id

For a Global App installed in the unit context with optional Atlassian app links, set each Atlassian app to required: false:

1
2
3
4
5
6
7
8
app:
  compatibility:
    jira:
      required: false
    confluence:
      required: false
  id: ari:cloud:ecosystem::app/your-app-id

For a multiple-app compatible app with a required Atlassian app, set one Atlassian app to required: true and any additional Atlassian apps to required: false:

1
2
3
4
5
6
7
8
app:
  compatibility:
    confluence:
      required: true
    jira:
      required: false
  id: ari:cloud:ecosystem::app/your-app-id

For guidance on choosing a compatibility model, see App compatibility.

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.
`location`	`string`	The full URL of the host page where this module is displayed.

Access your app

Global full page modules can be accessed using this URL format:

1
2
{site-hostname}/apps/full-page/{installation-id}/{route-prefix}/{app-route}

Where to find each value:

<site-hostname>: Your site name
<installation-id>: The UUID of the app installation. Run forge install list to find the UUID of the desired installation.
<route-prefix>: Defined in your manifest under routePrefix
<app-route>: Optional — if your app code contains routing, it will appear under the <app-route> section of the URL.

Example:

1
2
https://example.atlassian.net/apps/full-page/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/route-prefix