Jira sprint action (preview)

This section describes a Forge preview feature. Preview features are deemed stable; however, they remain under active development and may be subject to shorter deprecation windows. Preview features are suitable for early adopters in production environments.

We release preview features so partners and developers can study, test, and integrate them prior to General Availability (GA). For more information, see Forge release phases: EAP, Preview, and GA.

The jira:sprintAction module adds a menu item to the actions (•••) menu on the sprint card in the backlog view. When the menu item is clicked, the associated Forge app for the module is rendered.

Example of a sprint action button

Manifest structure

1
2
modules {}
└─ jira:sprintAction []
   ├─ key (string) [Mandatory]
   ├─ resource (string) [Mandatory]
   ├─ render (string) [Optional]
   ├─ resolver {} [Optional]
   ├─ title (string | i18n) [Mandatory]
   ├─ tooltip (string | i18n) [Optional]
   ├─ icon (string) [Optional]
   ├─ actionType (string) [Optional]
   ├─ viewportSize (string) [Optional]
   ├─ displayCondition {} [Optional]
   └─ actions [] [Optional]
     ├─ key (string) [Mandatory]
     ├─ title (string | i18n) [Mandatory]
     ├─ tooltip (string | i18n) [Optional]
     ├─ actionType (string) [Optional]
     └─ viewportSize (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 sprint 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`		The tooltip of the sprint 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.
`actions.key`	`string`	Yes, if using `actions`	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_-]+$` To determine the key of the action that was triggered, use the `action` property in the `extension` property of the context object. For example: `(await view.getContext()).extension.action;`
`actions.title`	`string` or `i18n object`	Yes, if using `actions`	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.
`actions.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.
`actions.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.
`actions.actionType`	`'modal'` or `'dynamic'`		Specifies how an action is executed within 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.
`project.id`	`string`	The id of the project where the module is rendered.
`project.key`	`string`	The key of the project where the module is rendered.
`project.type`	`string`	The type of the project where the module is rendered.
`board.id`	`string`	The id of the project where the module is rendered.
`board.type`	`"simple" \| "scrum" \| "kanban"`	The type of the board where the module is rendered.
`sprint.id`	`string`	The id of the sprint where the module is rendered.
`sprint.state`	`"active" \| "future"`	The state of the sprint where the module is rendered.

Manifest example

1
2
modules:
  jira:sprintAction:
    - key: hello-world-sprint-action-module
      resource: main
      resolver:
        function: resolver
      render: native
      title: Hello World
      icon: https://developer.atlassian.com/platform/forge/images/icons/issue-panel-icon.svg
      viewportSize: medium
      actions:
        - key: action_1
          title: Action 1
        - key: action_2
          title: Action 2
          tooltip: tooltip for action 2
          viewportSize: small