Bitbucket modules
Common modules
Compass modules
Confluence modules
Jira modules
Jira Service Management modules

Jira project settings page

The jira:projectSettingsPage module adds an item to the project settings sidebar.

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

For UI Kit 1, see the ProjectSettingsPage component documentation for an example. When adding this to your app, use it as a top-level component.

Example of an project settings page


By default, the jira:projectSettingsPage 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 settings page URL, you will need to handle routes inside your custom UI app using view.createHistory().

This feature works only with custom UI.

Manifest example

    - key: hello-world-project-settings-page
      resource: main
        function: resolver
      render: native
      title: Hello World





A key for the module, which other modules can refer to. Must be unique within the manifest.

Regex: ^[a-zA-Z0-9_-]+$

functionstringRequired if using UI Kit 1.A reference to the function module that defines the module. Only used in UI Kit 1.
resourcestringRequired if using custom UI or the latest version of UI Kit.A reference to the static resources entry that your context menu app wants to display. See resources for more details.
render'native'Yes for 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.

titlestringYesThe title of the project settings page, which is displayed at the top of the page. The title also appears as an item in the `Project settings` section of the left navigation of Jira settings.

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 settings page that defines whether a page is rendered with default controls (native) or lays out the entire viewport with margin on the left and breadcrumbs (basic for UI Kit) or taking the 100% of the page (blank for Custom UI).
pagesPage[]You can only specify `pages` or `sections` but not both.The list of subpages to render on the sidebar.
sectionsSection[]The list of sections to render on the sidebar.
displayConditionsobjectThe object that defines whether a module is displayed in the UI of the app. See display conditions.


titlestringYesThe title of the subpage, which is displayed on the sidebar.
iconstringThe URL of the icon that's displayed next to the subpage title. A generic app icon is displayed if no icon is provided.
routestringYesThe unique identifier of the subpage. This identifier is appended to the project settings page URL.


headerstringThe section header.
pagesPage[]YesThe list of subpages to render on the sidebar.

Extension data

UI Kit and Custom UI

Use the useProductContext hook to access the extension context in UI Kit or getContext bridge method in custom UI.

typestringThe type of the module.
project.idstringThe ID of the project where the module is rendered.
project.keystringThe key of the project where the module is rendered.
project.typestringThe type of the project where the module is rendered.

UI Kit 1

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

Extension context

typestringThe type of the module.

Platform context

projectIdstringThe ID of the project where the module is rendered.
projectKeystringThe key of the project where the module is rendered.
projectTypestringThe type of the project where which the module is rendered.

Rate this page: