jquery.hotkeys.js 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. /*
  2. * jQuery Hotkeys Plugin
  3. * Copyright 2010, John Resig
  4. * Dual licensed under the MIT or GPL Version 2 licenses.
  5. *
  6. * Based upon the plugin by Tzury Bar Yochay:
  7. * http://github.com/tzuryby/hotkeys
  8. *
  9. * Original idea by:
  10. * Binny V A, http://www.openjs.com/scripts/events/keyboard_shortcuts/
  11. */
  12. /*
  13. * One small change is: now keys are passed by object { keys: '...' }
  14. * Might be useful, when you want to pass some other data to your handler
  15. */
  16. (function(jQuery){
  17. jQuery.hotkeys = {
  18. version: "0.8",
  19. specialKeys: {
  20. 8: "backspace", 9: "tab", 10: "return", 13: "return", 16: "shift", 17: "ctrl", 18: "alt", 19: "pause",
  21. 20: "capslock", 27: "esc", 32: "space", 33: "pageup", 34: "pagedown", 35: "end", 36: "home",
  22. 37: "left", 38: "up", 39: "right", 40: "down", 45: "insert", 46: "del",
  23. 96: "0", 97: "1", 98: "2", 99: "3", 100: "4", 101: "5", 102: "6", 103: "7",
  24. 104: "8", 105: "9", 106: "*", 107: "+", 109: "-", 110: ".", 111 : "/",
  25. 112: "f1", 113: "f2", 114: "f3", 115: "f4", 116: "f5", 117: "f6", 118: "f7", 119: "f8",
  26. 120: "f9", 121: "f10", 122: "f11", 123: "f12", 144: "numlock", 145: "scroll", 186: ";", 191: "/",
  27. 220: "\\", 222: "'", 224: "meta"
  28. },
  29. shiftNums: {
  30. "`": "~", "1": "!", "2": "@", "3": "#", "4": "$", "5": "%", "6": "^", "7": "&",
  31. "8": "*", "9": "(", "0": ")", "-": "_", "=": "+", ";": ": ", "'": "\"", ",": "<",
  32. ".": ">", "/": "?", "\\": "|"
  33. }
  34. };
  35. function keyHandler( handleObj ) {
  36. if ( typeof handleObj.data === "string" ) {
  37. handleObj.data = { keys: handleObj.data };
  38. }
  39. // Only care when a possible input has been specified
  40. if ( !handleObj.data || !handleObj.data.keys || typeof handleObj.data.keys !== "string" ) {
  41. return;
  42. }
  43. var origHandler = handleObj.handler,
  44. keys = handleObj.data.keys.toLowerCase().split(" "),
  45. textAcceptingInputTypes = ["text", "password", "number", "email", "url", "range", "date", "month", "week", "time", "datetime", "datetime-local", "search", "color", "tel"];
  46. handleObj.handler = function( event ) {
  47. // Don't fire in text-accepting inputs that we didn't directly bind to
  48. if ( this !== event.target && (/textarea|select/i.test( event.target.nodeName ) ||
  49. jQuery.inArray(event.target.type, textAcceptingInputTypes) > -1 ) ) {
  50. return;
  51. }
  52. var special = jQuery.hotkeys.specialKeys[ event.keyCode ],
  53. // character codes are available only in keypress
  54. character = event.type === "keypress" && String.fromCharCode( event.which ).toLowerCase(),
  55. modif = "", possible = {};
  56. // check combinations (alt|ctrl|shift+anything)
  57. if ( event.altKey && special !== "alt" ) {
  58. modif += "alt+";
  59. }
  60. if ( event.ctrlKey && special !== "ctrl" ) {
  61. modif += "ctrl+";
  62. }
  63. // TODO: Need to make sure this works consistently across platforms
  64. if ( event.metaKey && !event.ctrlKey && special !== "meta" ) {
  65. modif += "meta+";
  66. }
  67. if ( event.shiftKey && special !== "shift" ) {
  68. modif += "shift+";
  69. }
  70. if ( special ) {
  71. possible[ modif + special ] = true;
  72. }
  73. if ( character ) {
  74. possible[ modif + character ] = true;
  75. possible[ modif + jQuery.hotkeys.shiftNums[ character ] ] = true;
  76. // "$" can be triggered as "Shift+4" or "Shift+$" or just "$"
  77. if ( modif === "shift+" ) {
  78. possible[ jQuery.hotkeys.shiftNums[ character ] ] = true;
  79. }
  80. }
  81. for ( var i = 0, l = keys.length; i < l; i++ ) {
  82. if ( possible[ keys[i] ] ) {
  83. return origHandler.apply( this, arguments );
  84. }
  85. }
  86. };
  87. }
  88. jQuery.each([ "keydown", "keyup", "keypress" ], function() {
  89. jQuery.event.special[ this ] = { add: keyHandler };
  90. });
  91. })( this.jQuery );