Limited availability
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 read-only object with functions for retrieving the string associated with specific physical keys.
A KeyboardLayoutMap instance is a read-only Map-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 the UI Events KeyboardEvent code Values specification.
Instance propertiesKeyboardLayoutMap.size Read only Experimental
Returns the number of elements in the KeyboardLayoutMap object.
KeyboardLayoutMap[Symbol.iterator]() Experimental
Returns a new Iterator 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 of KeyboardLayoutMap.
KeyboardLayoutMap.get() Experimental
Returns the element with the given key from the KeyboardLayoutMap object.
KeyboardLayoutMap.has() Experimental
Returns a boolean indicating whether the KeyboardLayoutMap object has an element with the specified key.
KeyboardLayoutMap.keys() Experimental
Returns a new Iterator object that contains the keys for each index in the KeyboardLayoutMap object.
KeyboardLayoutMap.values() Experimental
Returns a new Iterator object that contains the values for each index in the KeyboardLayoutMap object.
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.`);
});
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4