Display conditions
Modules

Rate this page:

Jira project settings page

The jira:projectSettingsPage module adds an item to the project settings sidebar. Use the UI kit or custom UI to create content for the page. When using the UI kit in an app, use the ProjectSettingsPage component as a top-level component.

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

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 URL of the icon that displays next to the title. A generic app icon is displayed if no URL is provided.
layoutnative|basic (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 (basic).
displayConditionsobjectThe object that defines whether a module is displayed in the UI of the app. See display conditions.

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: