The jiraServiceManagement:portalUserMenuAction
module adds a menu item to the user menu that shows up on Jira Service Management customer portal.
When the menu item is clicked, the module's function renders a modal dialog.
This module can be used in Jira Service Management.
For UI Kit 1, see the PortalUserMenuAction component documentation for an example. When adding this to your app, use it as a top-level component.
Unlicensed user access: This module supports interaction with customer accounts and unlicensed accounts. It does not support anonymous access. For information, see Access to Forge apps for unlicensed users.
This is an example of the triggered modal dialog:
Property | Type | Required | Description |
---|---|---|---|
key |
| Yes |
A key for the module, which other modules can refer to. Must be unique within the manifest. Regex: |
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 Set the | |
viewportSize | 'small' , 'medium' , 'large' or 'xlarge' | The display size of resource . Can only be set if the module is using the resource property. Remove this property to enable automatic resizing of the module. | |
title | string | Yes | The title of the issue action, which is displayed as a menu item. |
unlicensedAccess | List<string> | A list of unlicensed user types that can access this function. Valid values for this module are: unlicensed and customer . This module does not support anonymous access. For more information, see
Access to Forge apps for unlicensed Jira Service Management users.
|
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. |
Property | Type | Description |
---|---|---|
type | string | The type of the module. |
Rate this page: