SeanMcP / all-keyboardevent-keys

โŒจ๏ธ All KeyboardEvent Keys
https://npmjs.com/package/all-keyboardevent-keys
MIT License
7 stars 1 forks source link
hacktoberfest

All* KeyboardEvent Keys

npm npm bundle size (minified) npm PRs Welcome

Note: This library is a work in progress. Checkout the contribution guidelines to see how you can help.

Install

Add with your favorite package manager:

npm install --save all-keyboardevent-keys
# or
yarn add all-keyboardevent-keys

Use

Import the default KEY object, then use:

import KEY from 'all-keyboardevent-keys'

KEY is an object with nearly all available KeyboardEvent keys. You can view the full list available here.

You can access word keys using dot notation:

import { KEY } from 'onkey-event-manager'

KEY.Enter // 'Enter'
KEY.Tab   // 'Tab'

To access symbols or numbers, use bracket notation:

KEY[9]    // '9'
KEY['\\'] // '\'

Keyboards

Each keyboard has its own set of Keyboardevent keys. It is the goal of this project to gather all keys into a single library.

Current

To add a keyboardevent keys for your keyboard language, please read the contributing guide and make a pull request.

Languages to add

Don't see your keyboard language? File an issue requesting it.

Collaborators

License

MIT