Documentation

Overview  ·  Actions  ·  Site rules  ·  Export & import  ·  Permissions  ·  FAQ

Everything here describes version 1.0.0. If something in the extension does not match what is written here, the extension is right and this page is wrong — please tell us.

The shape of a shortcut

A shortcut is four things: the keys you press, the action it runs, where it applies, and whether it is on. All four are set per shortcut.

There are exactly two settings that apply to everything at once: a master switch that turns all shortcuts off, and the typing protection described below. Nothing else is global.

Getting started

• Open the extension's options page (right-click the toolbar icon, or use the popup).
• Select Add shortcut, click the key recorder, then press the combination you want. Letters and digits are recorded by physical key position, so Shift+2 is stored as shift+2 rather than as @.
• Choose one of the 29 actions.
• Leave Where it applies as All sites, or restrict it — see site rules.

Page shortcuts need one permission

Key presses can only be detected on a page by code running on that page, so the first time you use a page-level shortcut the extension asks for access to websites. It installs without that access, and you can revoke it later — see permissions.

Three things it deliberately does not do

• It does not fire while you are typing. Text fields, text areas, select elements and anything contenteditable are left alone — including inputs inside a shadow DOM. You can turn this off per your own preference, but it is off by default.
• It does not interfere with input method composition. While an IME is composing (Chinese, Japanese, Korean and others), key events are ignored entirely.
• Letters and digits ignore your keyboard layout. They are captured by physical key position, so a shortcut recorded on QWERTY still works on AZERTY or Dvorak. Punctuation and symbol keys are captured by the character they produce, so those can differ between layouts.