Jira issue navigator action

The jira:issueNavigatorAction module adds a menu item to the apps menu on the issue navigator view. When the menu item is clicked, the associated Forge app for the module is rendered.

Example of the issue navigator action menu item: Example of an issue navigator action button

Manifest structure

1
2
modules {}
└─ jira:issueNavigatorAction []
   ├─ key (string) [Mandatory]
   ├─ resource (string) [Mandatory]
   ├─ render (string) [Optional]
   ├─ resolver {} [Optional]
   ├─ title (string | i18n) [Mandatory]
   ├─ tooltip (string | i18n) [Optional]
   ├─ icon (string) [Optional]
   ├─ viewportSize (string) [Optional]
   ├─ displayCondition {} [Optional]
   ├─ actionType (string) [Optional]
   └─ actions [] [Optional]
     ├─ key (string) [Mandatory]
     ├─ title (string | i18n) [Mandatory]
     ├─ tooltip (string | i18n) [Optional]
     ├─ viewportSize (string) [Optional]
     └─ actionType (string) [Optional]

resources []
├─ key (string) [Mandatory]
└─ path (string) [Mandatory]

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`	Yes	A reference to the static `resources` entry that your context menu app wants to display. See resources for more details.
`render`	`'native'`	Yes for UI Kit.	Indicates the module uses UI Kit.
`resolver`	`{ function: string }` or `{ endpoint: string }`	Yes	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.
`viewportSize`	`'small'`, `'medium'`, `'large'`, `'xlarge'` or `'max'`		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` or `i18n object`	Yes	The title of the issue navigator action, which is displayed as a menu item. The `i18n object` allows for translation and is available to participants of the Internationalization for Forge EAP. See i18n object.
`tooltip`	`string` or `i18n object`	Yes	The tooltip of the issue navigator action menu item, which is displayed on hover. 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.
`displayConditions`	`object`		The object that defines whether or not a module is displayed in the UI of the app. See display conditions.
`actionType`	`'modal'` or `'dynamic'`		Specifies how an action is executed by the app, providing options for modal or dynamic implementations. Defaults to `'modal'`. See action type.
`actions`	`Action`		Defines nested actions supported by this module, which are accessed by hovering on the app item in the more actions menu. See Action.

`Action`

Defines nested actions supported by this module, which are accessed by hovering on the app menu item in the more actions menu.

1
2
actions [] [Optional]
  ├─ key (string) [Mandatory]
  ├─ title (string | i18n) [Mandatory]
  ├─ tooltip (string | i18n) [Optional]
  ├─ actionType (string) [Optional]
  └─ viewportSize (string) [Optional]

Key	Type	Required	Description
`key`	`string`	Yes	A key for the action nested in this module, which allows the app resources to load different setups or code paths based on the action triggered. Must be unique to the module. Regex: `^[a-zA-Z0-9_-]+$`
`title`	`string` or `i18n object`	Yes	The title of the action, which is displayed as a nested menu item. The `i18n object` allows for translation and is available to participants of the Internationalization for Forge EAP. See i18n object.
`tooltip`	`string` or `i18n object`		The tooltip of the action menu item, which is displayed on hover. The `i18n object` allows for translation and is available to participants of the Internationalization for Forge EAP. See i18n object.
`viewportSize`	`'small'`, `'medium'`, `'large'`, `'xlarge'` or `'max'`		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.
`actionType`	`'modal'` or `'dynamic'`		Specifies how an action is executed by the app, providing options for modal or dynamic implementations. Defaults to `'modal'`. See action type.

`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.

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.
`filterId`	`string`	The id of the issue navigator filter where the module is rendered.
`issueKeys`	`string`	The list of keys of the selected issues.
`jql`	`string`	The jql query.
`action`	`string`	The selected action key. Sent only when `Action[]` is present in a module.

Manifest example

1
2
modules:
  jira:issueNavigatorAction:
    - key: hello-world-issue-navigator-action
      resource: main
      resolver:
        function: resolver
      render: native
      title: Hello World
      actions:
        - key: action_1
          title: Action 1 
          viewportSize: large
        - key: action-2
          title: Action 2
          tooltip: tooltip for action 2
          actionType: dynamic