KeyboardLayoutMap

Experimental

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The KeyboardLayoutMap interface of the Keyboard API is a map-like object with functions for retrieving the string associated with specific physical keys. A list of valid keys is found in the UI Events KeyboardEvent code Values specification.

Properties

KeyboardLayoutMap.entries Read only   This is an experimental API that should not be used in production code.
Returns an array of a given object's own enumerable property [key, value] pairs, in the same order as that provided by a for...in loop (the difference being that a for-in loop enumerates properties in the prototype chain as well). 
KeyboardLayoutMap.keys Read only   This is an experimental API that should not be used in production code.
Returns a new Array Iterator object that contains the keys for each index in the array.
KeyboardLayoutMap.size Read only   This is an experimental API that should not be used in production code.
Returns the number of elements in the KeyboardLayoutMap object.
KeyboardLayoutMap.values Read only   This is an experimental API that should not be used in production code.
Returns a new Array Iterator object that contains the values for each index in the KeyboardLayoutMap object.

Methods

KeyboardLayoutMap.forEach() Read only   This is an experimental API that should not be used in production code.
Executes a provided function once for each element of KeyboardLayoutMap.
KeyboardLayoutMap.get() This is an experimental API that should not be used in production code.
Returns the element with the given key from the KeyboardLayoutMap object.
KeyboardLayoutMap.has() This is an experimental API that should not be used in production code.
Returns a boolean indicating whether the KeyboardLayoutMap object has an element with the specified key.

Examples

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

Specification Status Comment
Keyboard Map
The definition of 'KeyboardLayoutMap' in that specification.
Editor's Draft Initial definition.

Browser compatibility

BCD tables only load in the browser