Class KeycodeLayout

A concrete implementation of IKeyboardLayout based on keycodes.

The keyCode property of a 'keydown' event is a browser and OS specific representation of the physical key (not character) which was pressed on a keyboard. While not the most convenient API, it is currently the only one which works reliably on all browsers.

This class accepts a user-defined mapping of keycode to key, which allows for reliable shortcuts tailored to the user's system.

Hierarchy

  • KeycodeLayout

Implements

Constructors

constructor

Properties

_codes _keys _modifierKeys name

Methods

isModifierKey isValidKey keyForKeydownEvent keys

Constructors

constructor

Properties

Private _codes

_codes: CodeMap

Private _keys

_keys: KeySet

Private _modifierKeys

_modifierKeys: KeySet

Readonly name

name: string

The human readable name of the layout.

Methods

isModifierKey

isValidKey

  • Test whether the given key is a valid value for the layout.

    Returns

    true if the key is valid, false otherwise.

    Parameters

    • key: string

      The user provided key to test for validity.

    Returns boolean

keyForKeydownEvent

  • Get the key for a 'keydown' event.

    Returns

    The associated key value, or an empty string if the event does not represent a valid primary key.

    Parameters

    • event: KeyboardEvent

      The event object for a 'keydown' event.

    Returns string

keys

Settings

Member Visibility

Theme

Generated using TypeDoc