Class KeycodeLayout

constructor

• new KeycodeLayout(name, codes, modifierKeys?): KeycodeLayout

• Construct a new keycode layout.

  Parameters

  • name: string

    The human readable name for the layout.
  • codes: CodeMap

    A mapping of keycode to key value.
  • modifierKeys: string[] = []

    Array of modifier key names

  Returns KeycodeLayout

Readonly name

isModifierKey

• isModifierKey(key): boolean

• Test whether the given key is a modifier key.

  Parameters

  • key: string

    The user provided key.

  Returns boolean

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

isValidKey

• isValidKey(key): boolean

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

  Parameters

  • key: string

    The user provided key to test for validity.

  Returns boolean

  true if the key is valid, false otherwise.

keyForKeydownEvent

• keyForKeydownEvent(event): string

• Get the key for a 'keydown' event.

  Parameters

  • event: KeyboardEvent

    The event object for a 'keydown' event.

  Returns string

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

keys

• keys(): string[]

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

  Returns string[]

  A new array of the supported key values.