vimkey

Vim-like key mapping

Usage no npm install needed!

<script type="module">
  import vimkey from 'https://cdn.skypack.dev/vimkey';
</script>

README

Vimkey

Vim-like key mapping for the web from Vimlide.

Install

$ spm install vimkey --save

Usage

var Vimkey = require('vimkey');
var LINE_HEIGHT = 100;

var normalMode = new Vimkey(document, {
  countable: true,
});
normalMode.map('<Esc>', function(evt) {
  this.reset();
  evt.stopPropagation();
});
normalMode.map('j', function(evt, count = 1) {
  window.scrollBy(LINE_HEIGHT * count, 0);
  evt.stopPropagation();
});

API

.map(String key, Function handler)

key mapping.