Skip to content

Commit c1c63e0

Browse files
committed
Core: Documenting $.ui.keyCode. Fixes jquery#139.
1 parent b48cb8b commit c1c63e0

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

entries/keyCode.xml

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<?xml version="1.0"?>
2+
<entry type="property" name="keyCode" return="Object">
3+
<title>.keyCode</title>
4+
<desc>A mapping of key code descriptions to their numeric values.</desc>
5+
<longdesc>
6+
<p><code>$.ui.keyCode</code> is an object that maps key code descriptions to their corresponding numerical values. The object contains the following properties:</p>
7+
<ul>
8+
<li>BACKSPACE</li>
9+
<li>COMMA</li>
10+
<li>DELETE</li>
11+
<li>DOWN</li>
12+
<li>END</li>
13+
<li>ENTER</li>
14+
<li>ESCAPE</li>
15+
<li>HOME</li>
16+
<li>LEFT</li>
17+
<li>PAGE_DOWN</li>
18+
<li>PAGE_UP</li>
19+
<li>PERIOD</li>
20+
<li>RIGHT</li>
21+
<li>SPACE</li>
22+
<li>TAB</li>
23+
<li>UP</li>
24+
</ul>
25+
</longdesc>
26+
<example>
27+
<desc>Test for arrow key presses.</desc>
28+
<code><![CDATA[$( document ).on( "keydown", function( event ) {
29+
switch( event.keyCode ) {
30+
case $.ui.keyCode.LEFT:
31+
console.log( "left" );
32+
break;
33+
case $.ui.keyCode.RIGHT:
34+
console.log( "right" );
35+
break;
36+
case $.ui.keyCode.UP:
37+
console.log( "up" );
38+
break;
39+
case $.ui.keyCode.DOWN:
40+
console.log( "down" );
41+
break;
42+
}
43+
});]]></code>
44+
</example>
45+
<category slug="ui-core"/>
46+
</entry>

0 commit comments

Comments
 (0)