Keyboard: getLayoutMap() method
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.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The getLayoutMap() method of the
Keyboard interface returns a Promise that resolves with
an instance of KeyboardLayoutMap which is a map-like object with
functions for retrieving the strings associated with specific physical keys.
Syntax
getLayoutMap()
Parameters
None.
Return value
A Promise that resolves with an instance of
KeyboardLayoutMap.
Exceptions
SecurityErrorDOMException-
Thrown if the call is blocked by a permission policy.
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 # h-keyboard-getlayoutmap |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
getLayoutMap
|
|
|
|
|
|
|
|
|
|
|
|
|
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.