Bitbucket modules (EAP)
Common modules
Compass modules
Confluence modules
Jira modules
Jira Service Management modules

Rate this page:

Jira Service Management portal user menu action

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.

You can use the UI kit or custom UI to create content for the Jira Service Management page.

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.

Example of a Portal user menu action button

This is an example of the triggered modal dialog:

Example of a Portal user menu with the above sample code

Properties

PropertyTypeRequiredDescription
key

string

YesA key for the module, which other modules can refer to. Must be unique within the manifest.

Regex: ^[a-zA-Z0-9_-]+$

functionstringThe issue action module requires either a function for usage with the UI kit, or a resource when building with custom UI.A reference to the function module that defines the issue action. This function must return the PortalUserMenuAction component, which renders the modal dialog for its content.
resourcestringA reference to the static resources entry that your issue action 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.
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.
titlestringYesThe title of the issue action, which is displayed as a menu item.
unlicensedAccessList<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.

Extension context

Custom UI

PropertyTypeDescription
typestringThe type of the module.

UI kit

PropertyTypeDescription
typestringThe type of the module.

Rate this page: