Keyboard.getLayoutMap()
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
navigator.keyboard.getLayoutMap()
Parameters
None.
Return value
A Promise
that resolves with an instance of
KeyboardLayoutMap
.
Example
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.
var keyboard = navigator.keyboard;
keyboard.getLayoutMap()
.then(keyboardLayoutMap => {
var upKey = keyboardLayoutMap.get('KeyW');
window.alert('Press ' + upKey + ' to move up.');
})
Specifications
Specification |
---|
Keyboard Map # h-keyboard-getlayoutmap |
Browser compatibility
BCD tables only load in the browser