Interface IKeyboardLayout

An object which represents an abstract keyboard layout.

Hierarchy

  • IKeyboardLayout

Implemented by

Properties

name

Methods

isModifierKey isValidKey keyForKeydownEvent keys

Properties

Readonly name

name: string

The human readable name of the layout.

This value is used primarily for display and debugging purposes.

Methods

isModifierKey

  • Test whether the given key is a modifier key.

    Returns

    true if the key is a modifier key, false otherwise.

    Notes

    This is necessary so that we don't process modifier keys pressed in the middle of the key sequence. E.g. "Shift C Ctrl P" is actually 4 keydown events: "Shift", "Shift P", "Ctrl", "Ctrl P", and events for "Shift" and "Ctrl" should be ignored.

    Parameters

    • key: string

      The user provided key.

    Returns boolean

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

  • Get an array of all key values supported by the layout.

    Returns

    A new array of the supported key values.

    Notes

    This can be useful for authoring tools and debugging, when it's necessary to know which keys are available for shortcut use.

    Returns string[]

Settings

Member Visibility

Theme

Generated using TypeDoc