Rate this 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.
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.
Property | Type | Required | Description |
---|---|---|---|
key |
| Yes |
A key for the module, which other modules can refer to. Must be unique within the manifest. Regex: |
function | string | The 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. |
resource | string | A 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. | |
title | string | Yes | The 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. |
icon | string |
The icon displayed next to the For custom UI and UI kit apps, the 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 )
| 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). | |
pages | Page[] | You can only specify `pages` or `sections` but not both. | The list of subpages to render on the sidebar. |
sections | Section[] | The list of sections to render on the sidebar. | |
displayConditions | object | The object that defines whether a module is displayed in the UI of the app. See display conditions. |
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 settings page URL. |
Property | Type | Required | Description |
---|---|---|---|
header | string | The section header. | |
pages | Page[] | Yes | The list of subpages to render on the sidebar. |
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. |
Use the useProductContext hook to access the context in UI Kit.
Property | Type | Description |
---|---|---|
type | string | The type of the module. |
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. |
Rate this page: