This section describes a Forge preview feature. Preview features are deemed stable; however, they remain under active development and may be subject to shorter deprecation windows. Preview features are suitable for early adopters in production environments.

We release preview features so partners and developers can study, test, and integrate them prior to General Availability (GA). For more information, see Forge release phases: EAP, Preview, and GA.

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.

Manifest structure

1
2
modules []
└─ jira:fullPage {}
   ├─ key (string) [Mandatory]
   ├─ resource (string) [Mandatory]
   ├─ routePrefix (string) [Mandatory]
   ├─ render (string) [Mandatory for UI Kit only]
   ├─ resolver {} [Optional]
   └─ title {} [Optional]

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

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` or `i18n object`	No	The title of the full page, which is displayed in the tab title. The `i18n object` allows for translation. See i18n object.

i18n object

Key	Type	Required	Description
`i18n`	`string`	Yes	A key referencing a translated string in the translation files. For more details, see Translations.

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.

Accessing Jira full page module

Full page modules can be accessed using this URL format:

1
2
https://<your-site>.atlassian.net/forge-apps/a/<app-id>/e/<forge-environment-id>/r/<route-prefix>/<app-route>

Where to find each value:

<your-site>: Your site name
<app-id>: The UUID from your app.id in manifest.yml (if in ARI format like ari:cloud:ecosystem::app/UUID, use only the UUID section)
<forge-environment-id>: The UUID of the environment that the app is installed on. Run forge environments list to find the UUID of the desired environment.
<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/forge-apps/a/21e590df-79e6-40dd-9ee4-ba2c7b678f26/e/9f699e8b-33f1-4fa7-bd48-c5fdc44fa4c2/r/ui-kit

Example

Dashboard app

This tutorial demonstrates how to build a full-page Forge app for Jira with a dashboard featuring interactive bar charts, period selection buttons, and Jira API integration. Includes both UI Kit and Custom UI implementations.

Start tutorial

Please see the Jira full page dashboard example app for a complete code example on building an app using the Jira full page module.