KeyboardEvent key属性

DOM イベント KeyboardEvent

定義と使用方法

key属性は、キーボタンイベントが発生した時に押されたキーの識別子を返します。

キー識別子は、キーボタンを識別する文字列です。この属性の返却値は以下の文字列のいずれかです：

  • 単一の文字（例えば「a」、「W」、「4」、「+」または「$」）
  • 複数の文字（例えば「F1」、「Enter」、「HOME」または「CAPS LOCK」）

注記：この属性は読み取り専用です。

ヒント：キーボタンイベントが発生した時に「ALT」、「CTRL」、「META」または「SHIFT」キーが押されたかどうかを知りたい場合は、以下を使用してください： altKey、ctrlKey、metaKey または shiftKey 属性。

例

例 1

キーボタンイベントが発生した時の押されたキーボタンを取得する：

var x = event.key;

実際に試してみる

例 2

"A"キーが押された場合、テキストを表示します：

var x = event.key;
// キーボタンが 'a' または 'A'（CapsLockまたはShiftを使用）の場合、テキストを表示します。
if (x == "a" || x == "A") { 
  alert("'A'キーを押しました!");
}

実際に試してみる

文法

event.key

技術的な詳細

返却値：

文字列で、押されたキーボタンを表します。

可能な値：

  • 単一の文字（例えば「a」、「W」、「4」、「+」または「$」）
  • 複数の文字（例えば「F1」、「Enter」、「HOME」または「CAPS LOCK」）

注記：Safari では未定義を返します。
DOM バージョン： DOM レベル 3

ブラウザのサポート

このテーブルの数字は、その属性を完全にサポートする最初のブラウザのバージョンを示しています。

属性 Chrome IE Firefox Safari Opera
key 51.0 9.0 23.0 サポート外 38.0

関連ページ

HTML DOM リファレンス：KeyboardEvent keyCode プロパティ

HTML DOM リファレンス：KeyboardEvent which プロパティ

HTML DOM リファレンス：KeyboardEvent charCode プロパティ

DOM イベント KeyboardEvent