Class KeyHandler

Classdesc

A generic key handler.

Example

Example

// Javascript
    new KeyHandler( { trackAll : true } )
        .down('enter',function() { console.log('ENTER was hit.'); } )
        .press('enter',function() { console.log('ENTER was pressed.'); } )
        .up('enter',function() { console.log('ENTER was released.'); } )

         .down('e',function() { console.log('e was hit. shift is pressed?',keyHandler.isDown('shift')); } )

        .up('windows',function() { console.log('windows was released.'); } )
    ;

Constructors

constructor

Properties

_keyDownListener _keyPressListener _keyUpListener downListeners element keyStates pressListeners trackAllKeys upListeners KEY_CODES

Methods

destroy down fireDownEvent fireEvent firePressEvent fireUpEvent installListeners isDown press releaseListeners up key2code

Constructors

constructor

  • new KeyHandler(options): KeyHandler

  • The constructor.

    Parameters

    • options: {
          element?: typeof globalThis | HTMLElement | Window;
          trackAll?: boolean;
      }
      • Optional element?: typeof globalThis | HTMLElement | Window

        (optional) The HTML element to listen on; if null then 'window' will be used.

      • Optional trackAll?: boolean

        (optional) Set to true if you want to keep track of all keys (keyStatus).

    Returns KeyHandler

    Instance

    Memberof

    KeyHandler

Properties

Private _keyDownListener

_keyDownListener: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: KeyboardEvent

      Returns void

Private _keyPressListener

_keyPressListener: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: KeyboardEvent

      Returns void

Private _keyUpListener

_keyUpListener: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: KeyboardEvent

      Returns void

Private downListeners

downListeners: any[] = []

Private element

element: typeof globalThis | HTMLElement | Window

Private keyStates

keyStates: Record<number, string> = {}

Private pressListeners

pressListeners: any[] = []

Private trackAllKeys

trackAllKeys: boolean

Private upListeners

upListeners: any[] = []

Static Private KEY_CODES

KEY_CODES: Record<string, number> = ...

Source: https://keycode.info/

Methods

destroy

  • destroy(): void

  • This function should invalidate any installed listeners and invalidate this object. After calling this function the object might not hold valid data any more and should not be used any more.

    Returns void

down

  • down(key, listener): KeyHandler

  • Listen for key down. This function allows chaining.

    Example: new KeyHandler().down('enter',function() {console.log('Enter hit.')});

    Parameters

    • key: string | number

      Any key identifier, key code or one from the KEY_CODES list.

    • listener: XKeyCallback

    Returns KeyHandler

    this

    Name

    down

    Memberof

    KeyHandler

    Instance

Private fireDownEvent

  • fireDownEvent(e, handler): void
  • Private

    Internal function to fire a new keydown event to all listeners. You should not call this function on your own unless you know what you do.

    Parameters

    Returns void

    Name

    fireDownEvent

    Memberof

    KeyHandler

    Instance

Private fireEvent

  • fireEvent(event, listeners): boolean

  • A helper function to fire key events from this KeyHandler.

    Parameters

    • event: KeyboardEvent

      The key event to fire.

    • listeners: XKeyListener[]

    Returns boolean

Private firePressEvent

  • firePressEvent(e, handler): void
  • Private

    Internal function to fire a new keypress event to all listeners. You should not call this function on your own unless you know what you do.

    Parameters

    Returns void

    void

    Name

    firePressEvent

    Memberof

    KeyHandler

    Instance

Private fireUpEvent

  • fireUpEvent(e, handler): void
  • Private

    Internal function to fire a new keyup event to all listeners. You should not call this function on your own unless you know what you do.

    Parameters

    Returns void

    Name

    fireUpEvent

    Memberof

    KeyHandler

    Instance

installListeners

  • installListeners(): void

  • Install the required listeners into the initially passed element.

    By default the listeners are installed into the root element specified on construction (or 'window').

    Returns void

isDown

  • isDown(key): boolean

  • Check if a specific key is currently held pressed.

    Parameters

    • key: string | number

      Any key identifier, key code or one from the KEY_CODES list.

    Returns boolean

press

  • press(key, listener): KeyHandler

  • Listen for key press.

    Example: new KeyHandler().press('enter',function() {console.log('Enter pressed.')});

    Parameters

    • key: string | number

      Any key identifier, key code or one from the KEY_CODES list.

    • listener: XKeyCallback

      The callback to be triggered.

    Returns KeyHandler

    this

    Name

    press

    Memberof

    KeyHandler

    Instance

releaseListeners

  • releaseListeners(): void

  • Remove all installed event listeners from the underlying element.

    Returns void

up

  • up(key, listener): KeyHandler

  • Listen for key up.

    Example: new KeyHandler().up('enter',function() {console.log('Enter released.')});

    Parameters

    • key: string

      Any key identifier, key code or one from the KEY_CODES list.

    • listener: XKeyCallback

    Returns KeyHandler

    this

    Name

    up

    Memberof

    KeyHandler

    Instance

Static key2code

  • key2code(key): number

  • Resolve the key/name code.

    Parameters

    • key: string | number

    Returns number

Settings

Member Visibility

Theme

On This Page

constructor_keyDownListener_keyPressListener_keyUpListenerdownListenerselementkeyStatespressListenerstrackAllKeysupListenersKEY_CODESdestroydownfireDownEventfireEventfirePressEventfireUpEventinstallListenersisDownpressreleaseListenersupkey2code

Generated using TypeDoc