Package Exports

keyboard-event-key-type
keyboard-event-key-type/index.ts

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (keyboard-event-key-type) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Keyboard Event Key Types

Description

A simple Typescript package that contains the types of the keyboard-event-key as string-literals like: ArrowDown, ArrowUp and so on.

Getting Started

Installing

npm install --save keyboard-event-key-type

Usage

document.addEventListener('keydown', function ( event ) {
    const actualKey = <KeyboardEventKey>event.key
    const actionKey : KeyboardEventKey = "ArrowDown" // <- intellisense
    if (actualKey === actionKey) {
        // clicked !
    }
})

IntelliSense

The package mainly helps with the IDE-IntelliSense: Alt text

Supported types

All keys are taken from developer.mozilla.KeyboardEvent.Keys as of 11/19/2021, with additional support to custom keys.

NumericKeypadKeys
UpperAlpha
LowerAlpha
ModifierKeys
WhitespaceKeys
NavigationKeys
EditingKeys
UIKeys
DeviceKeys
IMECompositionKeys
LinuxDeadKeys
FunctionKeys
PhoneKeys
MultimediaKeys
TVControlKeys
MediaControllerKeys
SpeechRecognitionKeys
DocumentKeys
ApplicationSelectorKeys
BrowserControlKeys
KoreanKeyboardsOnly
DeprecatedWhitespaceKey
SpecialValueKey
CustomValueKey