This module now has support for UI Kit 2 (preview) for faster user experiences and to access additional React features.

For more information on all the supported modules, see the Supported products and their modules section.

Jira project page

The jira:projectPage module adds an item in the Apps section of the left navigation of Jira company-managed project settings in the project sidebar. When the item is clicked, content is rendered on a new Jira page.

For Jira Work Management, you can access the item from the project view navigation (horizontal navigation above your project's view) under the Apps dropdown.

For more information on the project sidebar, see Manage projects, shortcuts, versions, reports and more.

The page URL is constructed in the form of: /jira/{projectType}/projects/{projectKey}/apps/{appId}/{envId}

You can use the UI kit or custom UI to create content for the Jira page.

This module can be used in Jira Work Management, Jira Software, and Jira Service Management.

See the ProjectPage component documentation for an example. When adding this to your app, use it as a top-level component.

Example of a project page

Subpages

By default, the jira:projectPage module registers a top-level page. However, there is an option to register multiple pages using a pages or sections field.

Use pages to add individual pages to the sidebar and sections to group pages.

The sidebar will only change the project page URL, you will need to handle routes inside your custom UI app using view.createHistory().

This feature works only with custom UI.

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`	The project page module requires a `function` for use with the UI kit or a `resource` when building with custom UI.	A reference to the `function` module that defines the project page. This function must return the ProjectPage component.
`resource`	`string`		A reference to the static `resources` entry that your project page wants to display. See resources for more details.
`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 (preview) to integrate with a remote back end. Can only be set if the module is using the `resource` property.
`title`	`string`	Yes	The title of the project page, which is displayed at the top of the page. The title also appears as an item in the `Apps` section of the left navigation of Jira company-managed project settings.
`icon`	`string`		The icon displayed next to the `title`. For custom UI and UI kit apps, the `icon` property accepts a relative path from a declared resource. Alternatively, you can also use an absolute URL to a self-hosted icon. 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.
`layout`	UI Kit: `native` `basic` Custom UI: `native` `blank` `basic (deprecated)` (default: `native`)		The layout of the project page that defines whether a page is rendered with default controls (native), lays out the entire viewport with a margin on the left and breadcrumbs (basic for UI kit), or is left blank allowing for full customization (blank for custom UI).
`pages`	`Page[]`	You can only specify `pages` or `sections` but not both.	The list of subpages to render on the sidebar.
`sections`	`Section[]`	You can only specify `pages` or `sections` but not both.	The list of sections to render on the sidebar.
`displayConditions`	`object`		The object that defines whether or not a module is displayed in the UI of the app. See display conditions.

Page

Property	Type	Required	Description
`title`	`string`	Yes	The title of the subpage, which is displayed on the sidebar.
`icon`	`string`		The URL of the icon that's displayed next to the subpage title. A generic app icon is displayed if no icon is provided.
`route`	`string`	Yes	The unique identifier of the subpage. This identifier is appended to the project page URL.

Section

Property	Type	Required	Description
`header`	`string`		The section header.
`pages`	`Page[]`	Yes	The list of subpages to render on the sidebar.

Extension data

Custom UI

Use the getContext bridge method to access the extension context in custom UI.

Property	Type	Description
`type`	`string`	The type of the module.
project: `id`	`string`	The id of the project where the module is rendered.
project: `key`	`string`	The key of the project where the module is rendered.
project: `type`	`string`	The type of the project where the module is rendered.

UI kit

Use the useProductContext hook to access the context in UI Kit.

Extension context

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

Platform context

Property	Type/value	Description
`projectId`	`string`	The ID of the project where the module is rendered.
`projectKey`	`string`	The key of the project where the module is rendered.
`projectType`	`string`	The type of the project where which the module is rendered.