W3cubDocs

/Web APIs

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

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.

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

Specifications

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 69 79 No 56 No 69 No 48 No 10.0 69 No

See also

© 2005–2025 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/KeyboardLayoutMap/forEach