keyboard-key

WebJar for keyboard-key

License

License

MIT
Categories

Categories

KeY Data Data Formats Formal Verification
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

keyboard-key
Last Version

Last Version

1.0.4
Release Date

Release Date

Type

Type

jar
Description

Description

keyboard-key
WebJar for keyboard-key
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/levithomason/keyboard-key

Download keyboard-key

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/keyboard-key/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>keyboard-key</artifactId>
    <version>1.0.4</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/keyboard-key/
implementation 'org.webjars.npm:keyboard-key:1.0.4'
// https://jarcasting.com/artifacts/org.webjars.npm/keyboard-key/
implementation ("org.webjars.npm:keyboard-key:1.0.4")
'org.webjars.npm:keyboard-key:jar:1.0.4'
<dependency org="org.webjars.npm" name="keyboard-key" rev="1.0.4">
  <artifact name="keyboard-key" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='keyboard-key', version='1.0.4')
)
libraryDependencies += "org.webjars.npm" % "keyboard-key" % "1.0.4"
[org.webjars.npm/keyboard-key "1.0.4"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

keyboard-key CircleCI Codecov David npm

A simple utility for determining the KeyboardEvent.key property from a keyboard event.

Install

yarn add keyboard-key

# or

npm install keyboard-key

Usage

getKey()

Get the key property value from an event.

document.addEventListener('keydown', event => {
  const key = keyboardKey.getKey(event)

  switch (key) {
    case 'Escape':
      // handle escape key
      break
    default:
      break
  }
})

See MDN or the source for a full list of key values.

getCode()

You can also get the normalized keyCode from an event. keyboard-key includes a hash of key names to keyCodes for easy comparisons:

document.addEventListener('keydown', event => {
  const code = keyboardKey.getCode(event)

  switch (code) {
    case keyboardKey.Escape: // 27
      // handle escape key
      break
    default:
      break
  }
})

Why?

Most previous key identifying KeyboardEvent properties have been pressed have been deprecated in favor of Keyboard.key.

๐Ÿ‘Ž KeyboardEvent.char
๐Ÿ‘Ž KeyboardEvent.charCode
๐Ÿ‘Ž KeyboardEvent.keyCode
๐Ÿ‘Ž KeyboardEvent.keyIdentifier
๐Ÿ‘Ž KeyboardEvent.keyLocation
๐Ÿ‘Ž KeyboardEvent.which

๐Ÿ‘ KeyboardEvent.key

Unfortunately, KeyboardEvent.key does not yet have full browser support. Leaving the browsers without a reliable property for identifying keyboard event keys.

Locale Caveat

This utility interprets use of the shift key when inferring event key values. Example, an event describing shift+/ would result in a key value of ?. This logic assumes an en-US locale keyboard layout. This will not work if you are using a different locale such as a German layout where / is shift+7.

Versions

Version
1.0.4
1.0.2