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

Rate this page:

Jira project settings page

The jira:projectSettingsPage module adds an item to the project settings sidebar. 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 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

Subpages

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.

Properties

PropertyTypeRequiredDescription
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_-]+$

functionstringThe project settings 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 settings page. This function must return the ProjectSettingsPage component.
resourcestringA reference to the static resources entry that your project settings page wants to display. See resources for more details.
resolver{ function: string }Contains a function property, which references the function module that defines the configuration of resource. Can only be set if the module is using the resource property.
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.
iconstringThe absolute URL of the icon that's displayed next to the title. Relative URLs aren't supported. A generic app icon is displayed if no URL is provided.
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.

Page

PropertyTypeRequiredDescription
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.

Section

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

Extension context

Custom UI

PropertyTypeDescription
typestringThe type of the module.
project:
  id
stringThe ID of the project where the module is rendered.
project:
  key
stringThe key of the project where the module is rendered.
project:
  type
stringThe type of the project where the module is rendered.

UI kit

PropertyTypeDescription
typestringThe type of the module.
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: