js-keycodes v1.1.2

js-keycodes

Identify and work with keyCodes on JavaScript

Install

npm i -S js-keycodes

Usage

First import the lib into your code:

import * as KeyCodes from 'js-keycodes';

Or individual functions:

import { isLetter, isNumber } from 'js-keycodes';

Verify if a keyCode is a letter

import { isLetter } from 'js-keycodes';

const myKeyCode = 90;
if (isLetter(myKeyCode)) {
  // Do stuff if your keyCode is a letter
}

Verify if ENTER is pressed on an event

import { keyCodes } from 'js-keycodes';

const handleAnEvent = (event) => {
  if (event.which === keyCodes.ENTER) {
    // Do your stuff here.
  }
}

Methods

KeyCodes.isNumber()

Return true if the keyCode is a number from 0 to 9.

KeyCodes.isLetter()

Return true if the keyCode is a letter from A to Z.

KeyCodes.isNavigation()

Return true if the keyCode represents an Arrow key like UP, DOWN, LEFT or RIGHT.

KeyCodes.isWhitespace()

Return true if the keyCode represent ENTER, SPACE or TAB

KeyCodes.isF1ToF12()

Return true if the keyCode represent any of the F buttons from F1 to F12

KeyCodes.keyCodeToString()

Return a string representation of the keyCode.

import { keyCodeToString } from 'js-keycodes';

const myLetter = keyCodeToString(90);
// -> 'Z'

const myNumber = keyCodeToString(50)
//  '2'

KeyCodes.getKeyNameFromKeyCode()

Return a string representation based on the programmatic name of the keyCode

import { getKeyNameFromKeyCode } from 'js-keycodes';

const myLetter = getKeyNameFromKeyCode(90);
// -> 'Z'

const myNumber = getKeyNameFromKeyCode(50);
// -> 'TWO'

const myKey = getKeyNameFromKeyCode(13);
// -> 'ENTER'

const myF = getKeyNameFromKeyCode(121);
// -> 'F10'

Available Key Codes

Usage

import { keyCodes } from 'js-keycodes';

keyCodes.ENTER === 13;
// -> true
keyCodes.F12 === 123;
// -> true

// Using with JQuery
$.click((event) => {
  if (event.keyCode === keyCodes.F1) {
    // do an amazing think!
  }
});