KeyCode Constants

Installation

# Using npm
$ npm install keycode-js --save
# Using yarn
$ yarn add keycode-js
# Using bower
$ bower install keycode-js --save

Usage

// CommonJS
const KeyCode = require('keycode-js');
// ES2015+
import * as KeyCode from 'keycode-js';
// TypeScript
import * as KeyCode from 'keycode-js';
// Import individual constants
import { KEY_RETURN } from 'keycode-js';

<script src="https://unpkg.com/keycode-js@3.1.0/dist/keycode.min.js"></script>

window.addEventListener('keyup', function(e) {
 // You may do one of these checks.
 // Check the code value.
 if (e.code === KeyCode.CODE_RETURN) {
 console.log('It was the Return key.');
 return;
 }
 // OR, check the keyCode value.
 if (e.keyCode === KeyCode.KEY_RETURN) {
 console.log('It was the Return key.');
 return;
 }
 // OR, check the key value.
 if (e.key === KeyCode.VALUE_RETURN) {
 console.log('It was the Return key.');
 return;
 }
 console.log('It was any other key.');
});

Usage with Deno

// Import all constants
import * as KeyCode from 'https://deno.land/x/keycode@v3.1.0/mod.ts';
// Import individual constants
import { KEY_ENTER } from 'https://deno.land/x/keycode@v3.1.0/mod.ts';
console.assert(KeyCode.KEY_ENTER === KEY_ENTER);

Available Constants

1. Key event code constants

window.addEventListener('keyup', function(e) {
 console.log('Enter Key:', (e.code === KeyCode.CODE_RETURN));
});

2. Key code constants (numeric)

window.addEventListener('keyup', function(e) {
 console.log('Enter Key:', (e.keyCode === KeyCode.KEY_RETURN));
});

3. Key value constants

window.addEventListener('keyup', function(e) {
 console.log('Enter Key:', (e.key === KeyCode.VALUE_RETURN));
});

Contributing

Changelog

Maintainers

License