KeyboardLayoutMap

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental:This is anexperimental technology
Check theBrowser compatibility table carefully before using this in production.

TheKeyboardLayoutMap interface of theKeyboard API is a read-only object with functions for retrieving the string associated with specific physical keys.

AKeyboardLayoutMap instance is a read-onlyMap-like object, in which each key is a string identifying the unique physical key on the keyboard (a "key code"), and the corresponding value is the associated key attribute value (which may be affected by the keyboard layout, and so on).

A list of valid keys is found in theUI Events KeyboardEvent code Values specification.

Instance properties

KeyboardLayoutMap.sizeRead onlyExperimental: Returns the number of elements in theKeyboardLayoutMap object.

Instance methods

KeyboardLayoutMap[Symbol.iterator]()Experimental: Returns a newIterator object that contains the key/value pairs.
KeyboardLayoutMap.entries()Experimental: Returns a new Iterator object that contains the key/value pairs.
KeyboardLayoutMap.forEach()Experimental: Executes a provided function once for each element ofKeyboardLayoutMap.
KeyboardLayoutMap.get()Experimental: Returns the element with the given key from theKeyboardLayoutMap object.
KeyboardLayoutMap.has()Experimental: Returns a boolean indicating whether theKeyboardLayoutMap object has an element with the specified key.
KeyboardLayoutMap.keys()Experimental: Returns a new Iterator object that contains the keys for each index in theKeyboardLayoutMap object.
KeyboardLayoutMap.values()Experimental: Returns a new Iterator object that contains the values for each index in theKeyboardLayoutMap object.

Examples

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

navigator.keyboard.getLayoutMap().then((keyboardLayoutMap) => {  const upKey = keyboardLayoutMap.get("KeyW");  window.alert(`Press ${upKey} to move up.`);});