Keyboard.getLayoutMap

The getLayoutMap() method of the Keyboard interface returns a Promise that resolves with an instance of KeyboardLayoutMap which is a map-like object with fucntions for retrieving the strings associated with specific physical keys.

Syntax

var promise = Keyboard.getLayoutMap()

Parameters

None.

Return value

A Promise that resolves with an instance of KeyboardLayoutMap.

Example

The following example demonstrates how to get the location- or layout-specific string associated with the key that corresponds to the 'W' key on an English QWERTY keyboard.

var keyboard = navigator.keyboard;
keyboard.getLayoutMap()
.then(keyboardLayoutMap => {
  var upKey = keyboardLayoutMap.get('KeyW');
  window.alert('Press ' + upKey + ' to move up.');
}

Specifications

Browser compatibilityUpdate compatibility data on GitHub