keyboard-event-key-type

Contains strings literals for the keyboard event keys

1.5.0
latest
Source
npm

Version published: 3 years ago

Maintainers: 1

Created: 3 years ago

Source

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

Keywords

FAQs

What is keyboard-event-key-type?

Is keyboard-event-key-type well maintained?

Package last updated on 19 Nov 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install