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.
Instance properties
KeyboardLayoutMap.entries
Read only Experimental-
Returns an array of a given object's own enumerable property
[key, value]
pairs, in the same order as that provided by afor...in
loop (the difference being that afor-in
loop enumerates properties in the prototype chain as well). KeyboardLayoutMap.keys
Read only Experimental-
Returns a new array iterator object that contains the keys for each index in the array.
KeyboardLayoutMap.size
Read only Experimental-
Returns the number of elements in the
KeyboardLayoutMap
object. KeyboardLayoutMap.values
Read only Experimental-
Returns a new array iterator object that contains the values for each index in the
KeyboardLayoutMap
object.
Instance methods
KeyboardLayoutMap.forEach()
Read only 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.
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.
const keyboard = navigator.keyboard;
keyboard.getLayoutMap().then((keyboardLayoutMap) => {
const upKey = keyboardLayoutMap.get("KeyW");
window.alert(`Press ${upKey} to move up.`);
});
Specifications
Specification |
---|
Keyboard Map # keyboardlayoutmap-interface |
Browser compatibility
BCD tables only load in the browser