davejm/mousetrap-record

A plugin for mousetrap that allows you to record a keyboard sequence. This is a node module.

Record

This extension lets you use Mousetrap to record keyboard sequences and play them back.

This is a node module (works in node/electron or with something like browserify). For original plugin see this repo

Installation

npm install mousetrap-record --save

Note that you also need the core mousetrap module (npm install mousetrap --save).

Usage

var Mousetrap = require('mousetrap-record')(require('mousetrap'));

<button onclick="recordSequence()">Record</button>

<script>
    function recordSequence() {
        Mousetrap.record(function(sequence) {
            // sequence is an array like ['ctrl+k', 'c']
            console.log('You pressed: ' + sequence.join(' '));
        });
    }
</script>

If necessary, it's possible to change the default record timeout of 1000ms:

// at initialize
var Mousetrap = require('mousetrap-record')(require('mousetrap'), { timeout: 250 });

// or at record call
Mousetrap.record(function(sequence) {
    console.log('You pressed: ' + sequence.join(' '));
}, 3000);