Keyboard Shortcut Plugin Module
JIRA 4.1 and later
In JIRA 4.2 and later, the
Purpose of this Module TypeA keyboard shortcut plugin module defines a keyboard shortcut within JIRA. A JIRA keyboard shortcut allows you to perform potentially any action in JIRA using one or more keyboard strokes - for example, going to the Dashboard, browsing a project, moving your cursor to a field on a JIRA form, or creating, editing or commenting on an issue.
The root element for the keyboard shortcut plugin module is
keyboard-shortcut. It allows the following attributes and child elements for configuration:
In the example,
The localisation key for the human-readable name of the plugin module.
The human-readable name of the plugin module.
The plugin key.
A value that determines the order in which the shortcut appears on the Keyboard Shortcuts dialog box (with respect to other
A human-readable description of this keyboard shortcut module. May be specified as the value of this element for plain text or with the
The sequence of keystrokes required to activate the keyboard shortcut's operation. These should be presented in the order that the keys are pressed on a keyboard. For example,
A jQuery selector that specifies the target of the keyboard shortcut. The target is typically a component of the current page that performs an action. The
The section of the Keyboard Shortcuts dialog box on which the shortcut appears and defines where the keyboard shortcut can be used in JIRA. If this element contains:
Overriding Existing Keyboard Shortcuts
This feature is only available in JIRA 4.2 and later.
You can override an existing keyboard shortcut defined either within JIRA itself or in another plugin.
To do this create a
keyboard-shortcut plugin module with exactly the same
shortcut element's keystroke sequence as that of the keyboard shortcut you want to override. Then, ensure that an
order element is added, whose value is greater than that defined in the keyboard shortcut being overridden.
order element may affect the position of your overriding keyboard shortcut on the Keyboard Shortcuts dialog box, it will also prevent the overridden keyboard shortcut from:
- being accessed via the keyboard and
- appearing in the dialog box, on the proviso that you are overriding the keyboard shortcut within the same 'context' (i.e. with the same
It is possible to include an i18n resource in your
atlassian-plugin.xml to translate keyboard shortcut descriptions (via their '
key' attributes) into multiple languages. For examples code on including i18n resources in your
atlassian-plugin.xml file, please refer to Downloadable Plugin Resources.
These examples are taken from JIRA's pre-defined keyboard shortcuts for going to the Dashboard, commenting on an issue and moving to the next action item on an issue view.