@gedit/keyboard

Description

The @theia/keymaps allows the user to reconfigure default keybindings with custom keymaps.
By modifying the appropriate keymaps.json, the user can modify existing keybindings, or add keybindings to commands that do not yet have a keybinding associated to them.

Example of a valid keymaps.json file

[
    {
        "command": "quickCommand",
        "keybinding": "ctrl+shift+f4"
    }
]

where command is a unique command id and keybinding is a valid keybinding. There's also an optional context property that can be specified (which is also a unique string for a context id).

Supported Keys

For most keys you can directly use the name of the key i.e a, 3, /, -.

To use ctrl on Linux/Windows and cmd on OSX, use ctrlcmd.

You can use shift, ctrl, alt, meta, option (alt), command (meta), cmd (meta) as modifiers. Note that if you defined a custom shortcut with cmd, command or meta, the same keymaps file won't work on a Windows/Linux machine as this key doesn't have an equivalent.

You can also use the following strings for special keys: backspace, tab, enter, return, capslock, esc, escape, space, pageup, pagedown, end, home, left, up, right, down, ins, del and plus.

If unsure you can always look at the framework's supported keys

Key Sequences

Key sequences like: ctrl+x ctrl+a or ctrl+a b c are supported. With the following limitations:

• If the key sequence exceeds 1 key chord it won't show in the electron menu.
• If the key sequence exceeds 2 key chords it won't show in the command palette.

Additional Information

• API documentation for @theia/keymaps
• Theia - GitHub
• Theia - Website

License

• Eclipse Public License 2.0
• 一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception

Trademark

"Theia" is a trademark of the Eclipse Foundation https://www.eclipse.org/theia