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

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.

Manifest example

1
2
modules:
  jira:projectSettingsPage:
    - key: hello-world-project-settings-page
      resource: main
      resolver:
        function: resolver
      render: native
      title: Hello World

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.
`function`	`string`	Deprecated Required if using UI Kit 1	The key of a function module that returns a UI Kit 1 component.
`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.
`title`	`string` or `i18n object`	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. The `i18n object` allows for translation and is available to participants of the Internationalization for Forge EAP. See i18n object.
`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 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[]`	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 a module is displayed in the UI of the app. See display conditions.

i18n object

Internationalization (i18n) for Forge apps is now available through Forge's Early Access Program (EAP). For details on how to sign up for the EAP, see the changelog announcement.

EAPs are offered to selected users for testing and feedback purposes. APIs and features under EAP are unsupported and subject to change without notice. APIs and features under EAP are not recommended for use in production environments.

For more details, see Forge EAP, Preview, and GA.

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

Page

Property Type Required Description

Property	Type	Required	Description
`title`	`string` or `i18n object`	Yes	The title of the subpage, which is displayed on the sidebar. The `i18n object` allows for translation and is available to participants of the Internationalization for Forge EAP. See i18n object.
`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.

title

string or i18n object

Yes

The title of the subpage, which is displayed on the sidebar.

The i18n object allows for translation and is available to participants of the Internationalization for Forge EAP. See i18n object.

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.

Section

Property Type Required Description

Property	Type	Required	Description
`header`	`string` or `i18n object`		The section header. The `i18n object` allows for translation and is available to participants of the Internationalization for Forge EAP. See i18n object.
`pages`	`Page[]`	Yes	The list of subpages to render on the sidebar.

header

string or i18n object

The section header.

The i18n object allows for translation and is available to participants of the Internationalization for Forge EAP. See i18n object.

pages Page[] Yes The 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.

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 1

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

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.