KeyboardLayoutMap

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

KeyboardLayoutMap はキーボード API のインターフェイスで、読み取り専用のオブジェクトであり、特定の物理キーに関連付けられた文字列を取得するための関数を備えています。

KeyboardLayoutMap インスタンスは読み取り専用の Map 風オブジェクトであり、各キーはキーボード上の固有の物理キーを識別する文字列（「キーコード」）であり、対応する値は関連するキー属性値（キーボードレイアウトナドによって影響を受ける可能性があります）です。

有効なキーの一覧は UI Events KeyboardEvent code Values 仕様にあります。

インスタンスプロパティ

KeyboardLayoutMap.entries 読取専用

指定されたオブジェクト自身の列挙可能なプロパティ [key, value] ペアの配列を、 for...in ループで指定されたものと同じ順序で返します（for-in ループでは、プロトタイプチェーン内のプロパティも列挙される点が異なります）。

KeyboardLayoutMap.keys 読取専用

配列の各インデックスのキーを格納した新しい配列イテレーターオブジェクトを返します。

KeyboardLayoutMap.size 読取専用

KeyboardLayoutMap オブジェクトの要素数を返します。

KeyboardLayoutMap.values 読取専用

KeyboardLayoutMap オブジェクトの各インデックスの値を格納した新しい配列イテレーターオブジェクトを返します。

インスタンスメソッド

KeyboardLayoutMap.forEach() 読取専用

指定された関数を KeyboardLayoutMap の各要素に対して一度ずつだけ実行します。

KeyboardLayoutMap.get()

KeyboardLayoutMap オブジェクトから、指定されたキーを持つ要素を返します。

KeyboardLayoutMap.has()

KeyboardLayoutMap オブジェクトに指定したキーを持つ要素があるかどうかを示す論理値を返します。

例

次の例は、英語の QWERTY キーボードの 'W' キーに対応する場所またはレイアウトに依存した文字列を取得する方法を示しています。

js
const keyboard = navigator.keyboard;
keyboard.getLayoutMap().then((keyboardLayoutMap) => {
  const upKey = keyboardLayoutMap.get("KeyW");
  window.alert(`Press ${upKey} to move up.`);
});

仕様書

Specification
Keyboard Map
# keyboardlayoutmap-interface

ブラウザーの互換性

BCD tables only load in the browser