KeyboardLayoutMap

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

The KeyboardLayoutMap interface of the 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  
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  
Returns a new Array Iterator object that contains the keys for each index in the array.
KeyboardLayoutMap.size Read only  
Returns the number of elements in the KeyboardLayoutMap object.
KeyboardLayoutMap.values Read only  
Returns a new Array Iterator object that contains the values for each index in the KeyboardLayoutMap object.

Methods

KeyboardLayoutMap.forEach() Read only  
Executes a provided function once for each element of KeyboardLayoutMap.
KeyboardLayoutMap.get()
Returns the element with the given key from the KeyboardLayoutMap object.
KeyboardLayoutMap.has()
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
Unknown
The definition of 'KeyboardLayoutMap' in that specification.
Unknown Initial definition.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
Basic support
Experimental
Chrome Full support 69Edge No support NoFirefox No support NoIE No support NoOpera Full support 55Safari No support NoWebView Android No support NoChrome Android No support NoEdge Mobile No support NoFirefox Android No support NoOpera Android No support NoSafari iOS No support NoSamsung Internet Android No support No
entries
Experimental
Chrome Full support 69Edge No support NoFirefox No support NoIE No support NoOpera Full support 56Safari No support NoWebView Android No support NoChrome Android No support NoEdge Mobile No support NoFirefox Android No support NoOpera Android Full support 56Safari iOS No support NoSamsung Internet Android No support No
forEach
Experimental
Chrome Full support 69Edge No support NoFirefox No support NoIE No support NoOpera Full support 56Safari No support NoWebView Android No support NoChrome Android No support NoEdge Mobile No support NoFirefox Android No support NoOpera Android Full support 56Safari iOS No support NoSamsung Internet Android No support No
get
Experimental
Chrome Full support 69Edge No support NoFirefox No support NoIE No support NoOpera Full support 56Safari No support NoWebView Android No support NoChrome Android No support NoEdge Mobile No support NoFirefox Android No support NoOpera Android Full support 56Safari iOS No support NoSamsung Internet Android No support No
has
Experimental
Chrome Full support 69Edge No support NoFirefox No support NoIE No support NoOpera Full support 56Safari No support NoWebView Android No support NoChrome Android No support NoEdge Mobile No support NoFirefox Android No support NoOpera Android Full support 56Safari iOS No support NoSamsung Internet Android No support No
keys
Experimental
Chrome Full support 69Edge No support NoFirefox No support NoIE No support NoOpera Full support 56Safari No support NoWebView Android No support NoChrome Android No support NoEdge Mobile No support NoFirefox Android No support NoOpera Android Full support 56Safari iOS No support NoSamsung Internet Android No support No
size
Experimental
Chrome Full support 69Edge No support NoFirefox No support NoIE No support NoOpera Full support 56Safari No support NoWebView Android No support NoChrome Android No support NoEdge Mobile No support NoFirefox Android No support NoOpera Android No support NoSafari iOS No support NoSamsung Internet Android No support No
values
Experimental
Chrome Full support 69Edge No support NoFirefox No support NoIE No support NoOpera Full support 56Safari No support NoWebView Android No support NoChrome Android No support NoEdge Mobile No support NoFirefox Android No support NoOpera Android Full support 56Safari iOS No support NoSamsung Internet Android No support No

Legend

Full support  
Full support
No support  
No support
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.

Document Tags and Contributors

Contributors to this page: purisame, jpmedley
Last updated by: purisame,