makeup-key-emitter

makeup-key-emitter

Emits custom events for common accessibility keys (arrowRightKeyDown, escKeyDown, etc).

A vanilla JavaScript port of jquery-common-keydown.

Experimental

This module is still in an experimental state, until it reaches v1.0.0 you must consider all minor releases as breaking changes. Patch releases may introduce new features, but will be backwards compatible.

Install

// via npm
npm install makeup-key-emitter

// via yarn
yarn add makeup-key-emitter

Example

    const KeyEmitter = require('makeup-key-emitter');

    let el = document.getElementById('#widget1');

    KeyEmitter.addKeyDown(el);

    el.addEventListener('arrowRightKeyDown', function(e) {
        console.log(this, e.type); // outputs (el1, 'arrowRightKeyDown')
    });

Methods

• addKeyDown(el)
• addKeyUp(el)
• removeKeyDown(el)
• removeKeyUp(el)
• add(el)
• remove(el)

Development

• npm start
• npm test
• npm run lint
• npm run fix
• npm run build
• npm run clean

The following hooks exist, and do not need to be invoked manually:

• npm prepublish cleans, lints, tests and builds on every npm publish command
• pre-commit cleans, lints, tests and builds on every git commit command

Test Reports

Each test run will generate the following reports:

• /reports/coverage contains Istanbul code coverage report
• /reports/html contains HTML test report

CI Build

https://travis-ci.org/makeup-js/makeup-key-emitter

Code Coverage

https://coveralls.io/github/makeup-js/makeup-key-emitter