keyz v1.0.3

Keyz is very simple library for use in the JS enviroment.

It exposes single immutable object containing constants for keyboard keys.

Instalation

You can install it from npm:

npm install keyz --save

Or you can download keyz.min.js from the dist folder and then include it in html file:

<script src="keyz.min.js"></script>

Usage

Usually handler listening for events of specific key is created like this:

element.addEventListener("keydown", function(event) {
    if (event.keyCode == 13) {
        //do something
    }
})

It involves using magic numbers (like 13 in this example), which can make code hard to uderstand.

This library provides set of self-explaining constants, which can be imported and used like this:

import Keys from 'keyz'

element.addEventListener("keydown", function(event) {
    if (event.keyCode == Keys.ENTER) {
        //do something
    }
})

You can also import constants for specific keys:

import { PAGE_UP } from 'keyz'

element.addEventListener("keydown", function(event) {
    if (event.keyCode == PAGE_UP) {
        //do something
    }
})

List of all values: