enterkeyhint

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since November 2021.

enterkeyhintグローバル属性で、属性であり、仮想キーボードの [Enter] キーにどのようなアクションラベル(またはアイコン)を表示するかを定義する列挙型属性です。

試してみましょう

解説

フォームコントロール<textarea><input> 要素など)や contenteditable を使用している要素は、 inputmode 属性を指定して、どのような仮想キーボードを使用するかを制御することができます。さらに使い勝手を向上させるために、 [Enter] キーをどのようにラベル付けするか (またはどのアイコンを表示するか) を示す enterkeyhint 属性を指定することで、[Enter] キーを特別にカスタマイズすることができます。[Enter] キーは通常、ユーザーが次に何をすべきかを表します。よくある操作としては、テキストの送信、改行の挿入、検索などがあります。

もし enterkeyhint 属性が指定されなければ、ユーザーエージェントは inputmode, type, pattern 属性から文脈に合った情報を得て、適した [Enter] キーのラベル(またはアイコン)を表示するかもしれません。

enterkeyhint 属性は列挙型属性で、以下の値のみを受け入れることができます。

説明 ラベルの例(ユーザーエージェントとユーザーの言語に依存)
enterkeyhint="enter" ふつうは改行を挿入します。
enterkeyhint="done" 通常、それ以上のことは入力できず、インプットメソッドエディター (IME) が閉じられることを意味します。 完了
enterkeyhint="go" 一般的に、ユーザーが入力したテキストのターゲットに移動することを意味しています。 開く
enterkeyhint="next" 通常、ユーザーをテキストを受け入れる次のフィールドへ導きます。 次へ
enterkeyhint="previous" 通常、ユーザーをテキストを受け入れる前のフィールドへ導きます。 前へ
enterkeyhint="search" 通常、ユーザーを入力したテキストを検索した結果へ導きます。 検索
enterkeyhint="send" 通常、このテキストをターゲットに配信します。 送信

仕様書

Specification
HTML Standard
# attr-enterkeyhint

ブラウザーの互換性

BCD tables only load in the browser

関連情報