1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
---
title: keypress
slug: Web/API/Document/keypress_event
translation_of: Web/API/Document/keypress_event
---
<p>The <code>keypress</code> event is fired when a key is pressed down and that key normally produces a character value (use <a href="/en-US/Mozilla_event_reference/input"><code>input</code></a> instead).</p>
<h2 id="General_info">General info</h2>
<dl>
<dt style="float: left; text-align: right; width: 120px;">Specification</dt>
<dd style="margin: 0 0 0 120px;"><a class="external" href="http://www.w3.org/TR/DOM-Level-3-Events/#event-type-keypress">DOM L3</a> {{deprecated_inline()}}</dd>
<dt style="float: left; text-align: right; width: 120px;">Interface</dt>
<dd style="margin: 0 0 0 120px;"><a href="/en-US/docs/DOM/KeyboardEvent" title="http://en-US/docs/DOM/KeyboardEvent">KeyboardEvent</a></dd>
<dt style="float: left; text-align: right; width: 120px;">Bubbles</dt>
<dd style="margin: 0 0 0 120px;">Yes</dd>
<dt style="float: left; text-align: right; width: 120px;">Cancelable</dt>
<dd style="margin: 0 0 0 120px;">Yes</dd>
<dt style="float: left; text-align: right; width: 120px;">Target</dt>
<dd style="margin: 0 0 0 120px;">Document, Element</dd>
<dt style="float: left; text-align: right; width: 120px;">Default Action</dt>
<dd style="margin: 0 0 0 120px;">Varies: <code>keypress</code> event; launch text composition system; <code>blur</code> and <code>focus</code> events; <code>DOMActivate</code> event; other event</dd>
</dl>
<h2 id="Properties">Properties</h2>
<table class="standard-table">
<thead>
<tr>
<th scope="col">Property</th>
<th scope="col">Type</th>
<th scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>target</code> {{readonlyInline}}</td>
<td>EventTarget</td>
<td>The event target (the topmost target in the DOM tree).</td>
</tr>
<tr>
<td><code>type</code> {{readonlyInline}}</td>
<td>DOMString</td>
<td>The type of event.</td>
</tr>
<tr>
<td><code>bubbles</code> {{readonlyInline}}</td>
<td>Boolean</td>
<td>Whether the event normally bubbles or not</td>
</tr>
<tr>
<td><code>cancelable</code> {{readonlyInline}}</td>
<td>Boolean</td>
<td>Whether the event is cancellable or not?</td>
</tr>
<tr>
<td><code>view</code> {{readonlyInline}}</td>
<td>WindowProxy</td>
<td><a href="/en-US/docs/Web/API/Document/defaultView" title="In browsers, document.defaultView returns the window object associated with a document, or null if none is available."><code>document.defaultView</code></a> (<code>window</code> of the document)</td>
</tr>
<tr>
<td><code>detail</code> {{readonlyInline}}</td>
<td><code>long</code> (<code>float</code>)</td>
<td>0.</td>
</tr>
<tr>
<td><code>target</code> {{readonlyInline}}</td>
<td>EventTarget (DOM element)</td>
<td>Focused element processing the key event, root element if no suitable input element focused.</td>
</tr>
<tr>
<td><code>char</code> {{readonlyInline}}</td>
<td>DOMString (string)</td>
<td>The character value of the key. If the key corresponds to a printable character, this value is a non-empty Unicode string containing that character. If the key doesn't have a printable representation, this is an empty string. See <a href="/en-US/docs/Web/API/KeyboardEvent#Key_names_and_Char_values">key names and char values</a> for the detail.
<div class="note"><strong>Note:</strong> If the key is used as a macro that inserts multiple characters, this attribute's value is the entire string, not just the first character.</div>
</td>
</tr>
<tr>
<td><code>key</code> {{readonlyInline}}</td>
<td>DOMString (string)</td>
<td>The key value of the key represented by the event. If the value has a printed representation, this attribute's value is the same as the <code>char</code> attribute. Otherwise, it's one of the key value strings specified in {{ anch("Key values") }}. If the key can't be identified, this is the string "Unidentified". See <a href="/en-US/docs/Web/API/KeyboardEvent#Key_names_and_Char_values">key names and char values</a> for the detail. Read Only.</td>
</tr>
<tr>
<td><code>charCode</code> {{readonlyInline}}</td>
<td>Unsigned long (int)</td>
<td>The Unicode reference number of the key; this attribute is used only by the <a href="/en-US/docs/Mozilla_event_reference/keypress"><code>keypress</code></a> event. For keys whose <code>char</code> attribute contains multiple characters, this is the Unicode value of the first character in that attribute.
<div class="warning"><strong>Warning:</strong> This attribute is deprecated; you should use <code>char</code> instead, if available.</div>
</td>
</tr>
<tr>
<td><code>keyCode</code> {{readonlyInline}}</td>
<td>Unsigned long (int)</td>
<td>A system and implementation dependent numerical code identifying the unmodified value of the pressed key. This is usually the decimal ASCII ({{ RFC(20) }}) or Windows 1252 code corresponding to the key; see {{ anch("Virtual key codes") }} for a list of common values. If the key can't be identified, this value is 0.
<div class="warning"><strong>Warning:</strong> This attribute is deprecated; you should use <code>key</code> instead, if available.</div>
</td>
</tr>
<tr>
<td><code>which</code> {{readonlyInline}}</td>
<td>Unsigned long (int)</td>
<td>A system and implementation dependent numeric code identifying the unmodified value of the pressed key; this is usually the same as <code>keyCode</code>.
<div class="warning"><strong>Warning:</strong> This attribute is deprecated; you should use <code>key</code> instead, if available.</div>
</td>
</tr>
<tr>
<td><code>location</code> {{readonlyInline}}</td>
<td>long (float)</td>
<td>The location of the key on the device.</td>
</tr>
<tr>
<td><code>repeat</code> {{readonlyInline}}</td>
<td>boolean</td>
<td><code>true</code> if a key has been depressed long enough to trigger key repetition, otherwise <code>false</code>.</td>
</tr>
<tr>
<td><code>locale</code> {{readonlyInline}}</td>
<td>string</td>
<td>The language code for the key event, if available; otherwise, the empty string.</td>
</tr>
<tr>
<td><code>ctrlKey</code> {{readonlyInline}}</td>
<td>boolean</td>
<td><code>true</code> if the control key was down when the event was fired. <code>false</code> otherwise.</td>
</tr>
<tr>
<td><code>shiftKey</code> {{readonlyInline}}</td>
<td>boolean</td>
<td><code>true</code> if the shift key was down when the event was fired. <code>false</code> otherwise.</td>
</tr>
<tr>
<td><code>altKey</code> {{readonlyInline}}</td>
<td>boolean</td>
<td><code>true</code> if the alt key was down when the event was fired. <code>false</code> otherwise.</td>
</tr>
<tr>
<td><code>metaKey</code> {{readonlyInline}}</td>
<td>boolean</td>
<td><code>true</code> if the meta key was down when the event was fired. <code>false</code> otherwise.</td>
</tr>
</tbody>
</table>
<h2 id="Related_Events">Related Events</h2>
<ul>
<li>{{event("keydown")}}</li>
<li>{{event("keyup")}}</li>
<li>{{event("keypress")}}</li>
<li>{{event("input")}}</li>
</ul>
|
