KeyboardLayoutMap
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
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 properties
KeyboardLayoutMap.sizeRead only-
Returns the number of elements in the
KeyboardLayoutMapobject.
Instance methods
KeyboardLayoutMap[Symbol.iterator]()-
Returns a new Iterator object that contains the key/value pairs.
KeyboardLayoutMap.entries()-
Returns a new Iterator object that contains the key/value pairs.
KeyboardLayoutMap.forEach()-
Executes a provided function once for each element of
KeyboardLayoutMap. KeyboardLayoutMap.get()-
Returns the element with the given key from the
KeyboardLayoutMapobject. KeyboardLayoutMap.has()-
Returns a boolean indicating whether the
KeyboardLayoutMapobject has an element with the specified key. KeyboardLayoutMap.keys()-
Returns a new Iterator object that contains the keys for each index in the
KeyboardLayoutMapobject. KeyboardLayoutMap.values()-
Returns a new Iterator object that contains the values for each index in the
KeyboardLayoutMapobject.
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.`);
});
Specifications
| Specification |
|---|
| Keyboard Map # keyboardlayoutmap-interface |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
KeyboardLayoutMap
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[Symbol.iterator]
|
|
|
|
|
|
|
|
|
|
|
|
|
entries
|
|
|
|
|
|
|
|
|
|
|
|
|
forEach
|
|
|
|
|
|
|
|
|
|
|
|
|
get
|
|
|
|
|
|
|
|
|
|
|
|
|
has
|
|
|
|
|
|
|
|
|
|
|
|
|
keys
|
|
|
|
|
|
|
|
|
|
|
|
|
size
|
|
|
|
|
|
|
|
|
|
|
|
|
values
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.