Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.
The keypress
event is fired when a letter, number, punctuation, or symbol key is pressed, or else when the Enter key is pressed â including when the Enter key is pressed in combination with the Shift key or Ctrl key. Otherwise, when a modifier key such as the Alt, Shift, Ctrl, Meta, Esc, or Option key is pressed in isolation, the keypress
event is not fired.
Warning: Since this event has been deprecated, you should use beforeinput
or keydown
instead.
The event bubbles. It can reach Document
and Window
.
Use the event name in methods like addEventListener()
, or set an event handler property.
addEventListener("keypress", (event) => { })
onkeypress = (event) => { }
Event type Event properties
This interface also inherits properties of its parents, UIEvent
and Event
.
KeyboardEvent.altKey
Read only
Returns a boolean value that is true
if the Alt (Option or ⥠on macOS) key was active when the key event was generated.
KeyboardEvent.code
Read only
Returns a string with the code value of the physical key represented by the event.
KeyboardEvent.ctrlKey
Read only
Returns a boolean value that is true
if the Ctrl key was active when the key event was generated.
KeyboardEvent.isComposing
Read only
Returns a boolean value that is true
if the event is fired between after compositionstart
and before compositionend
.
KeyboardEvent.key
Read only
Returns a string representing the key value of the key represented by the event.
KeyboardEvent.location
Read only
Returns a number representing the location of the key on the keyboard or other input device. A list of the constants identifying the locations is shown in Keyboard locations.
KeyboardEvent.metaKey
Read only
Returns a boolean value that is true
if the Meta key (on Mac keyboards, the â Command key; on Windows keyboards, the Windows key (â)) was active when the key event was generated.
KeyboardEvent.repeat
Read only
Returns a boolean value that is true
if the key is being held down such that it is automatically repeating.
KeyboardEvent.shiftKey
Read only
Returns a boolean value that is true
if the Shift key was active when the key event was generated.
This example logs the KeyboardEvent.code
value whenever you press a key after focussing the <input>
element.
To see which keys cause a keypress
event to fire, and which keys don't, try pressing the following:
<div>
<label for="sample">Focus the input and type something:</label>
<input type="text" name="text" id="sample" />
</div>
<p id="log"></p>
const log = document.getElementById("log");
const input = document.querySelector("input");
input.addEventListener("keypress", logKey);
function logKey(e) {
log.textContent += ` ${e.code}`;
}
onkeypress equivalent
input.onkeypress = logKey;
Specifications Browser compatibility See also
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.3