keyboard-event-key-type
TypeScript icon, indicating that this package has built-in type declarations

1.5.0 • Public • Published

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

Package Sidebar

Install

npm i keyboard-event-key-type

Weekly Downloads

705

Version

1.5.0

License

ISC

Unpacked Size

76.7 kB

Total Files

6

Last publish

Collaborators

  • sooniic