Rate this page:
The jira:adminPage
module adds an item in the Apps
section of the left navigation of Jira admin
settings. When the item is clicked, content is rendered on a new Jira page.
You can use the UI kit or custom UI
to create content for the Jira page. When using the UI kit in the app, use the
AdminPage component as a top-level component.
The page URL is constructed in the form of: /jira/settings/apps/{appId}/{envId}
This module can be used in Jira Work Management, Jira Software, and Jira Service Management.
By default, the jira:adminPage
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.
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 admin 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 admin page. This function must return the AdminPage component. |
resource | string | A reference to the static resources entry that your admin 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 admin page, which is displayed at the top of the page. The title also appears as an item in the `Apps` section of the left navigation of Jira admin settings. |
icon | string | The URL of the icon that's displayed next to the title. A generic app icon is displayed if no icon is provided. | |
layout | native|basic (default: native ) | The layout of the admin page that defines whether a page is rendered with default controls (native) or lays out the entire viewport (basic). | |
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 or not 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 admin page URL. |
Property | Type | Required | Description |
---|---|---|---|
header | string | The section header. | |
pages | Page[] | Yes | The list of subpages to render on the sidebar. |
Property | Type | Description |
---|---|---|
type | string | The type of the module. |
Property | Type | Description |
---|---|---|
type | string | The type of the module. |
Rate this page: