Keyboard Shortcut

This module type adds the ability for an add-on to declare keyboard shortcuts. Currently only available for Jira.

A Connect keyboard shortcut can perform one of three actions: navigate to a page, open a dialog module, or invoke an action represented by a web-item on a page. Pages, dialog modules and web-items referenced by the shortcut must be declared by the same add-on.

A shortcut is identified by a sequence of letters which need to be pressed in order for the shortcut action to be invoked. You cannot declare shortcuts that would shadow shortcuts defined by the product. A shortcut shadows all shortcuts which start with its sequence.

On the other hand, it's possible to shadow shortcuts defined by the same or other add-ons, although those won't be accessible anymore.

In case multiple shortcuts have the same sequence, there is no guarantee on which will be invoked.

Example

1
2
{
  "modules": {
    "keyboardShortcuts": [
      {
        "shortcut": "gmm",
        "target": {
          "key": "page-key"
        },
        "context": "global",
        "name": {
          "value": "My keyboard shortcut"
        },
        "key": "keyboard-shortcut-key"
      }
    ]
  }
}

Properties

key

Example

For example, an add-on which looks like:

1
2
{
    "key": "my-addon",
    "modules": {
        "configurePage": {
            "key": "configure-me",
        }
    }
}

Will have a configuration page module with a URL of /plugins/servlet/ac/my-addon/configure-me.

name

Example

1
2
{
  "value": "My text"
}

Properties

shortcut

target

Properties

context