# @wiptheia/keymaps

> Theia - Custom Keymaps Extension

Latest version **0.3.101529329103** (published 2018-06-18) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @wiptheia/keymaps
pnpm add @wiptheia/keymaps
yarn add @wiptheia/keymaps
bun add @wiptheia/keymaps
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score; popular repo.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.3.101529329103 |
| Published | 2018-06-18 |
| First published | 2018-05-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 42.1 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 21709 |
| Maintainers | florentbenoit |
| Keywords | theia-extension |

## Links

- npm: https://www.npmjs.com/package/@wiptheia/keymaps
- Repository: https://github.com/theia-ide/theia
- Issues: https://github.com/theia-ide/theia/issues
- npm.io page: https://npm.io/package/@wiptheia/keymaps

## Dependencies (5)

- [ajv](https://npm.io/package/ajv.md) ^5.2.2
- [jsonc-parser](https://npm.io/package/jsonc-parser.md) ^1.0.1
- [@wiptheia/core](https://npm.io/package/@wiptheia/core.md) ^0.3.11
- [@wiptheia/workspace](https://npm.io/package/@wiptheia/workspace.md) ^0.3.11
- [@wiptheia/userstorage](https://npm.io/package/@wiptheia/userstorage.md) ^0.3.11

## Recent versions

- 0.3.101529329103 (latest) — 2018-06-18
- 0.3.101529316316 — 2018-06-18
- 0.3.101528895082 — 2018-06-13
- 0.3.101528878795 — 2018-06-13
- 0.3.101528708905 — 2018-06-11
- 0.3.101528377761 — 2018-06-07
- 0.3.101528290741 — 2018-06-06
- 0.3.101528281264 — 2018-06-06
- 0.3.101528129305 — 2018-06-04
- 0.3.101527835504 — 2018-06-01
- 0.3.101527832848 — 2018-06-01
- 0.3.101527753241 — 2018-05-31
- 0.3.101527588686 — 2018-05-29
- 0.3.101527586002 — 2018-05-29
- 0.3.101527002539 — 2018-05-22
- … 12 more at https://npm.io/package/@wiptheia/keymaps/versions

## README

# Theia - Keymaps Extension

See [here](https://github.com/theia-ide/theia) for a detailed documentation.

An extension that 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

```json
[
    {
        "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 [keys.ts](../core/src/common/keys.ts#207) to see if a string is supported.

## 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.

## License
[Apache-2.0](https://github.com/theia-ide/theia/blob/master/LICENSE)

---
_Source: https://npm.io/package/@wiptheia/keymaps · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._