KeyboardLayoutMap: forEach() 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.

The forEach() method of the KeyboardLayoutMap interface executes a provided function once for each element of the map.

The method is otherwise the same as Map.prototype.forEach().

Syntax

js
forEach(callbackFn)
forEach(callbackFn, thisArg)

Parameters

callbackFn

The function to execute for each element, taking three arguments:

currentValue

The value of the current element being processed.

index Optional

The index of the current element being processed.

array Optional

The KeyboardLayoutMap that forEach() is being called on.

thisArg Optional

Value to use as this (i.e., the reference Object) when executing callback.

Return value

None (undefined).

Examples

The following example iterates every location- or layout-specific string and its associated keyboard code on an English QWERTY keyboard.

js
navigator.keyboard.getLayoutMap().then((keyboardLayoutMap) => {
  keyboardLayoutMap.forEach((key, code) => {
    console.log(`${code} keyboard code represents ${key} key`);
  });
});

Specifications

Specification
ECMAScript® 2027 Language Specification
# sec-map.prototype.foreach

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
forEach
Experimental
Chrome – Full support
Chrome 69 (Release date: 2018-09-04)
footnote Full support
Edge – Full support
Edge 79 (Release date: 2020-01-15)
footnote Full support
Firefox – No support
Firefox
footnote No support
Opera – Full support
Opera 56 (Release date: 2018-09-25)
footnote Full support
Safari – No support
Safari
footnote No support
Chrome Android – Full support
Chrome Android 69 (Release date: 2018-09-04)
footnote Full support
Firefox for Android – No support
Firefox for Android
footnote No support
Opera Android – Full support
Opera Android 48 (Release date: 2018-11-08)
footnote Full support
Safari on iOS – No support
Safari on iOS
footnote No support
Samsung Internet – Full support
Samsung Internet 10 (Release date: 2019-08-22)
footnote Full support
WebView Android – Full support
WebView Android 69 (Release date: 2018-09-04)
footnote Full support
WebView on iOS – No support
WebView on iOS
footnote No support

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.

See also