Add a Keyboard Shortcut to Firefox Extension

Question

I'm developing a Firefox Extension. I added a new item to the "Tools" Menu to open my extension, but I would like to add a keyboard shortcut to open my extension (something like 'control + alt + x').

See also: https://developer.mozilla.org/en/XUL_Tutorial/Keyboard_Shortcuts — Wladimir Palant, Dec 22 '11 at 05:45

score 8 · Answer 1 · answered Mar 02 '21 at 06:57

The commands key is a good way to do this these days; for instance to toggle the main extension pop up (known as the browser_action), use the following in manifest.json:

"commands": {
  "_execute_browser_action": {
    "suggested_key": {
      "default": "Ctrl+Shift+Y"
    }
  }
}

This also exposes an entry in the Add-ons Manager -> Manage Extension Shortcuts settings area where the user can re-map the keyboard shortcut.

Read more on the documentation page: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/commands

This is the true answer. – Colin Woodbury Jul 12 '21 at 23:04 — Colin Woodbury, Jul 12 '21 at 23:04

score 7 · Accepted Answer · answered Dec 23 '11 at 14:31

7

I've found it by myself

<keyset id="mainKeyset"> <key id="key_convert" key="x" modifiers="accel alt" oncommand="OpenMyAddOn()"/> </keyset>

answered Dec 23 '11 at 14:31

Dante López

213
3
10

Arunas Bartisius · Answer 3 · 2016-02-19T12:27:34.093

0

If you need to add shortcut key to Firefox own menu to execute addon action, then you need to edit extension\content\firebug\firefox\browserMenu.js and add accesskey:

    // Firefox page context menu
    $menupopupOverlay(doc, $(doc, "contentAreaContextMenu"), [
        $menuseparator(doc),
        $menuitem(doc,{
            id: "menu_ext",
            ....
            accesskey: "s"
        })
    ]);

edited Feb 19 '16 at 12:27

answered Feb 19 '16 at 11:23

Arunas Bartisius

1,879
22
23

Add a Keyboard Shortcut to Firefox Extension

3 Answers3