This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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
var promise = 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 | Status | Comment |
---|---|---|
Keyboard Map The definition of 'getLayoutMap()' in that specification. |
Editor's Draft | Initial definition. |
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
getLayoutMap | Chrome Full support 69 | Edge Full support 79 | Firefox No support No | IE No support No | Opera Full support 56 | Safari No support No | WebView Android No support No | Chrome Android No support No | Firefox Android No support No | Opera Android No support No | Safari iOS No support No | Samsung Internet Android No support No |
Legend
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.