diff --git a/README.md b/README.md index 4160ebd..b4c5a0e 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,19 @@ Lastly, even though binding hotkeys in your templates/html tends to be a bad ide Example of how directive-based hotkeys works: ```html - + +``` + +another example: + +```html + ``` #### Cheatsheet diff --git a/build/hotkeys.js b/build/hotkeys.js index 7eb55f4..ab929a4 100644 --- a/build/hotkeys.js +++ b/build/hotkeys.js @@ -606,19 +606,41 @@ restrict: 'A', link: function (scope, el, attrs) { var keys = [], - allowIn; + allowIn, + hotkeyDescription, + hotkeyAction; angular.forEach(scope.$eval(attrs.hotkey), function (func, hotkey) { // split and trim the hotkeys string into array allowIn = typeof attrs.hotkeyAllowIn === "string" ? attrs.hotkeyAllowIn.split(/[\s,]+/) : []; + + if (typeof attrs.hotkeyDescription === "string") { + try { + hotkeyDescription = scope.$eval(attrs.hotkeyDescription)[hotkey]; + } catch(e) { + hotkeyDescription = attrs.hotkeyDescription; + } + } else { + hotkeyDescription = attrs.hotkeyDescription; + } + + if (typeof attrs.hotkeyAction === "string") { + try { + hotkeyAction = scope.$eval(attrs.hotkeyAction)[hotkey]; + } catch(e) { + hotkeyAction = attrs.hotkeyAction; + } + } else { + hotkeyAction = attrs.hotkeyAction; + } keys.push(hotkey); hotkeys.add({ combo: hotkey, - description: attrs.hotkeyDescription, + description: hotkeyDescription, callback: func, - action: attrs.hotkeyAction, + action: hotkeyAction, allowIn: allowIn }); }); @@ -1050,7 +1072,7 @@ } function _belongsTo(element, ancestor) { - if (element === document) { + if (element === null || element === document) { return false; } diff --git a/build/hotkeys.min.js b/build/hotkeys.min.js index 2817b9e..48dcde3 100644 --- a/build/hotkeys.min.js +++ b/build/hotkeys.min.js @@ -4,4 +4,4 @@ * Copyright (c) 2016 Wes Cruver * License: MIT */ -!function(){"use strict";angular.module("cfp.hotkeys",[]).provider("hotkeys",["$injector",function(a){this.includeCheatSheet=!0,this.useNgRoute=a.has("ngViewDirective"),this.templateTitle="Keyboard Shortcuts:",this.templateHeader=null,this.templateFooter=null,this.template='',this.cheatSheetHotkey="?",this.cheatSheetDescription="Show / hide this help menu",this.$get=["$rootElement","$rootScope","$compile","$window","$document",function(a,b,c,d,e){function f(){q=!1}function g(){q=!0}function h(a){var b={command:"⌘",shift:"⇧",left:"←",right:"→",up:"↑",down:"↓","return":"⏎",backspace:"⌫"};a=a.split("+");for(var c=0;c=0?a[c]="command":a[c]="ctrl"),a[c]=b[a[c]]||a[c];return a.join(" + ")}function i(a,b,c,d,e,f){this.combo=a instanceof Array?a:[a],this.description=b,this.callback=c,this.action=d,this.allowIn=e,this.persistent=f,this._formated=null}function j(){for(var a=r.hotkeys.length;a--;){var b=r.hotkeys[a];b&&!b.persistent&&m(b)}}function k(){r.helpVisible=!r.helpVisible,r.helpVisible?(w=n("esc"),m("esc"),l("esc",w.description,k,null,["INPUT","SELECT","TEXTAREA"])):(m("esc"),w!==!1&&l(w))}function l(a,b,c,d,e,f){var g,h=["INPUT","SELECT","TEXTAREA"],j=Object.prototype.toString.call(a);if("[object Object]"===j&&(b=a.description,c=a.callback,d=a.action,f=a.persistent,e=a.allowIn,a=a.combo),m(a),b instanceof Function?(d=c,c=b,b="$$undefined$$"):angular.isUndefined(b)&&(b="$$undefined$$"),void 0===f&&(f=!0),"function"==typeof c){g=c,e instanceof Array||(e=[]);for(var k,l=0;l-1)b=!0;else for(var e=0;e-1?(r.hotkeys[e].combo.length>1?r.hotkeys[e].combo.splice(r.hotkeys[e].combo.indexOf(b),1):(angular.forEach(s,function(a){var b=a.indexOf(r.hotkeys[e]);-1!==b&&a.splice(b,1)}),r.hotkeys.splice(e,1)),!0):!1}function n(a){if(!a)return r.hotkeys;for(var b,c=0;c-1)return b;return!1}function o(a){return a.$id in s||(s[a.$id]=[],a.$on("$destroy",function(){for(var b=s[a.$id].length;b--;)m(s[a.$id].pop())})),{add:function(b){var c;return c=arguments.length>1?l.apply(this,arguments):l(b),s[a.$id].push(c),this}}}function p(a){return function(c,d){if(a instanceof Array){var e=a[0],f=a[1];a=function(a){f.scope.$eval(e)}}b.$apply(function(){a(c,n(d))})}}var q=!0;Mousetrap.prototype.stopCallback=function(a,b){return q?(" "+b.className+" ").indexOf(" mousetrap ")>-1?!1:b.contentEditable&&"true"==b.contentEditable:!0},i.prototype.format=function(){if(null===this._formated){for(var a=this.combo[0],b=a.split(/[\s]/),c=0;c95&&112>a||r.hasOwnProperty(a)&&(q[r[a]]=a)}return q}function l(a,b,c){return c||(c=k()[a]?"keydown":"keypress"),"keypress"==c&&b.length&&(c="keydown"),c}function m(a){return"+"===a?["+"]:(a=a.replace(/\+{2}/g,"+plus"),a.split("+"))}function n(a,b){var c,d,e,f=[];for(c=m(a),e=0;e1?void q(a,g,b,c):(f=n(a,c),s._callbacks[f.key]=s._callbacks[f.key]||[],k(f.key,f.modifiers,{type:f.action},d,a,e),void s._callbacks[f.key][d?"unshift":"push"]({callback:b,modifiers:f.modifiers,action:f.action,seq:d,level:e,combo:a}))}var s=this;if(a=a||b,!(s instanceof p))return new p(a);s.target=a,s._callbacks={},s._directMap={};var t,u={},v=!1,w=!1,x=!1;s._handleKey=function(a,b,d){var e,f=k(a,b,d),g={},h=0,i=!1;for(e=0;e":".","?":"/","|":"\\"},u={option:"alt",command:"meta","return":"enter",escape:"esc",plus:"+",mod:/Mac|iPod|iPhone|iPad/.test(navigator.platform)?"meta":"ctrl"},v=1;20>v;++v)r[111+v]="f"+v;for(v=0;9>=v;++v)r[v+96]=v;p.prototype.bind=function(a,b,c){var d=this;return a=a instanceof Array?a:[a],d._bindMultiple.call(d,a,b,c),d},p.prototype.unbind=function(a,b){var c=this;return c.bind.call(c,a,function(){},b)},p.prototype.trigger=function(a,b){var c=this;return c._directMap[a+":"+b]&&c._directMap[a+":"+b]({},a),c},p.prototype.reset=function(){var a=this;return a._callbacks={},a._directMap={},a},p.prototype.stopCallback=function(a,b){var c=this;return(" "+b.className+" ").indexOf(" mousetrap ")>-1?!1:o(b,c.target)?!1:"INPUT"==b.tagName||"SELECT"==b.tagName||"TEXTAREA"==b.tagName||b.isContentEditable},p.prototype.handleKey=function(){var a=this;return a._handleKey.apply(a,arguments)},p.init=function(){var a=p(b);for(var c in a)"_"!==c.charAt(0)&&(p[c]=function(b){return function(){return a[b].apply(a,arguments)}}(c))},p.init(),a.Mousetrap=p,"undefined"!=typeof module&&module.exports&&(module.exports=p),"function"==typeof define&&define.amd&&define(function(){return p})}(window,document); \ No newline at end of file +!function(){"use strict";angular.module("cfp.hotkeys",[]).provider("hotkeys",["$injector",function(a){this.includeCheatSheet=!0,this.useNgRoute=a.has("ngViewDirective"),this.templateTitle="Keyboard Shortcuts:",this.templateHeader=null,this.templateFooter=null,this.template='',this.cheatSheetHotkey="?",this.cheatSheetDescription="Show / hide this help menu",this.$get=["$rootElement","$rootScope","$compile","$window","$document",function(a,b,c,d,e){function f(){q=!1}function g(){q=!0}function h(a){var b={command:"⌘",shift:"⇧",left:"←",right:"→",up:"↑",down:"↓","return":"⏎",backspace:"⌫"};a=a.split("+");for(var c=0;c=0?a[c]="command":a[c]="ctrl"),a[c]=b[a[c]]||a[c];return a.join(" + ")}function i(a,b,c,d,e,f){this.combo=a instanceof Array?a:[a],this.description=b,this.callback=c,this.action=d,this.allowIn=e,this.persistent=f,this._formated=null}function j(){for(var a=r.hotkeys.length;a--;){var b=r.hotkeys[a];b&&!b.persistent&&m(b)}}function k(){r.helpVisible=!r.helpVisible,r.helpVisible?(w=n("esc"),m("esc"),l("esc",w.description,k,null,["INPUT","SELECT","TEXTAREA"])):(m("esc"),w!==!1&&l(w))}function l(a,b,c,d,e,f){var g,h=["INPUT","SELECT","TEXTAREA"],j=Object.prototype.toString.call(a);if("[object Object]"===j&&(b=a.description,c=a.callback,d=a.action,f=a.persistent,e=a.allowIn,a=a.combo),m(a),b instanceof Function?(d=c,c=b,b="$$undefined$$"):angular.isUndefined(b)&&(b="$$undefined$$"),void 0===f&&(f=!0),"function"==typeof c){g=c,e instanceof Array||(e=[]);for(var k,l=0;l-1)b=!0;else for(var e=0;e-1?(r.hotkeys[e].combo.length>1?r.hotkeys[e].combo.splice(r.hotkeys[e].combo.indexOf(b),1):(angular.forEach(s,function(a){var b=a.indexOf(r.hotkeys[e]);-1!==b&&a.splice(b,1)}),r.hotkeys.splice(e,1)),!0):!1}function n(a){if(!a)return r.hotkeys;for(var b,c=0;c-1)return b;return!1}function o(a){return a.$id in s||(s[a.$id]=[],a.$on("$destroy",function(){for(var b=s[a.$id].length;b--;)m(s[a.$id].pop())})),{add:function(b){var c;return c=arguments.length>1?l.apply(this,arguments):l(b),s[a.$id].push(c),this}}}function p(a){return function(c,d){if(a instanceof Array){var e=a[0],f=a[1];a=function(a){f.scope.$eval(e)}}b.$apply(function(){a(c,n(d))})}}var q=!0;Mousetrap.prototype.stopCallback=function(a,b){return q?(" "+b.className+" ").indexOf(" mousetrap ")>-1?!1:b.contentEditable&&"true"==b.contentEditable:!0},i.prototype.format=function(){if(null===this._formated){for(var a=this.combo[0],b=a.split(/[\s]/),c=0;c95&&112>a||r.hasOwnProperty(a)&&(q[r[a]]=a)}return q}function l(a,b,c){return c||(c=k()[a]?"keydown":"keypress"),"keypress"==c&&b.length&&(c="keydown"),c}function m(a){return"+"===a?["+"]:(a=a.replace(/\+{2}/g,"+plus"),a.split("+"))}function n(a,b){var c,d,e,f=[];for(c=m(a),e=0;e1?void q(a,g,b,c):(f=n(a,c),s._callbacks[f.key]=s._callbacks[f.key]||[],k(f.key,f.modifiers,{type:f.action},d,a,e),void s._callbacks[f.key][d?"unshift":"push"]({callback:b,modifiers:f.modifiers,action:f.action,seq:d,level:e,combo:a}))}var s=this;if(a=a||b,!(s instanceof p))return new p(a);s.target=a,s._callbacks={},s._directMap={};var t,u={},v=!1,w=!1,x=!1;s._handleKey=function(a,b,d){var e,f=k(a,b,d),g={},h=0,i=!1;for(e=0;e":".","?":"/","|":"\\"},u={option:"alt",command:"meta","return":"enter",escape:"esc",plus:"+",mod:/Mac|iPod|iPhone|iPad/.test(navigator.platform)?"meta":"ctrl"},v=1;20>v;++v)r[111+v]="f"+v;for(v=0;9>=v;++v)r[v+96]=v;p.prototype.bind=function(a,b,c){var d=this;return a=a instanceof Array?a:[a],d._bindMultiple.call(d,a,b,c),d},p.prototype.unbind=function(a,b){var c=this;return c.bind.call(c,a,function(){},b)},p.prototype.trigger=function(a,b){var c=this;return c._directMap[a+":"+b]&&c._directMap[a+":"+b]({},a),c},p.prototype.reset=function(){var a=this;return a._callbacks={},a._directMap={},a},p.prototype.stopCallback=function(a,b){var c=this;return(" "+b.className+" ").indexOf(" mousetrap ")>-1?!1:o(b,c.target)?!1:"INPUT"==b.tagName||"SELECT"==b.tagName||"TEXTAREA"==b.tagName||b.isContentEditable},p.prototype.handleKey=function(){var a=this;return a._handleKey.apply(a,arguments)},p.init=function(){var a=p(b);for(var c in a)"_"!==c.charAt(0)&&(p[c]=function(b){return function(){return a[b].apply(a,arguments)}}(c))},p.init(),a.Mousetrap=p,"undefined"!=typeof module&&module.exports&&(module.exports=p),"function"==typeof define&&define.amd&&define(function(){return p})}(window,document); \ No newline at end of file diff --git a/package.json b/package.json index 75c6c0f..a98cabf 100644 --- a/package.json +++ b/package.json @@ -40,6 +40,7 @@ "karma-html2js-preprocessor": "~0.1.0", "karma-jasmine": "~0.1.3", "karma-phantomjs-launcher": "^0.2.0", - "karma-script-launcher": "~0.1.0" + "karma-script-launcher": "~0.1.0", + "phantomjs": "1.9" } } diff --git a/src/hotkeys.js b/src/hotkeys.js index 5b27ec1..9d99df2 100644 --- a/src/hotkeys.js +++ b/src/hotkeys.js @@ -600,19 +600,41 @@ restrict: 'A', link: function (scope, el, attrs) { var keys = [], - allowIn; + allowIn, + hotkeyDescription, + hotkeyAction; angular.forEach(scope.$eval(attrs.hotkey), function (func, hotkey) { // split and trim the hotkeys string into array allowIn = typeof attrs.hotkeyAllowIn === "string" ? attrs.hotkeyAllowIn.split(/[\s,]+/) : []; + + if (typeof attrs.hotkeyDescription === "string") { + try { + hotkeyDescription = scope.$eval(attrs.hotkeyDescription)[hotkey]; + } catch(e) { + hotkeyDescription = attrs.hotkeyDescription; + } + } else { + hotkeyDescription = attrs.hotkeyDescription; + } + + if (typeof attrs.hotkeyAction === "string") { + try { + hotkeyAction = scope.$eval(attrs.hotkeyAction)[hotkey]; + } catch(e) { + hotkeyAction = attrs.hotkeyAction; + } + } else { + hotkeyAction = attrs.hotkeyAction; + } keys.push(hotkey); hotkeys.add({ combo: hotkey, - description: attrs.hotkeyDescription, + description: hotkeyDescription, callback: func, - action: attrs.hotkeyAction, + action: hotkeyAction, allowIn: allowIn }); }); diff --git a/test/hotkeys.coffee b/test/hotkeys.coffee index 02cb9e9..ee2a0a7 100644 --- a/test/hotkeys.coffee +++ b/test/hotkeys.coffee @@ -444,7 +444,7 @@ describe 'Angular Hotkeys', -> describe 'hotkey directive', -> - elSimple = elAllowIn = elMultiple = scope = hotkeys = $compile = $document = executedSimple = executedAllowIn = null + elSimpleAction = elMultipleAction = elSimple = elAllowIn = elMultiple = scope = hotkeys = $compile = $document = executedSimple = executedAllowIn = null beforeEach -> module('cfp.hotkeys') @@ -463,7 +463,9 @@ describe 'hotkey directive', -> scope.callmeMultiple = () -> elSimple = $compile('
')(scope) elAllowIn = $compile('
')(scope) - elMultiple = $compile('
')(scope) + elMultiple = $compile('
')(scope) + elSimpleAction = $compile('
')(scope) + elMultipleAction = $compile('
')(scope) scope.$digest() it 'should allow hotkey binding via directive', -> @@ -489,9 +491,13 @@ describe 'hotkey directive', -> it 'should unbind the hotkey when the directive is destroyed', -> expect(hotkeys.get('e').combo).toEqual ['e'] + expect(hotkeys.get('e').description).toEqual 'testing simple case' expect(hotkeys.get('w').combo).toEqual ['w'] + expect(hotkeys.get('w').description).toEqual 'testing with allowIn' expect(hotkeys.get('a').combo).toEqual ['a'] + expect(hotkeys.get('a').description).toEqual 'test for a' expect(hotkeys.get('b').combo).toEqual ['b'] + expect(hotkeys.get('b').description).toEqual 'test for b' elSimple.remove() elAllowIn.remove() elMultiple.remove() @@ -500,6 +506,13 @@ describe 'hotkey directive', -> expect(hotkeys.get('a')).toBe no expect(hotkeys.get('b')).toBe no + it 'should handle actions simply and multiply', -> + expect(hotkeys.get('q').combo).toEqual ['q'] + expect(hotkeys.get('q').action).toEqual 'keypress' + expect(hotkeys.get('u').combo).toEqual ['u'] + expect(hotkeys.get('u').action).toEqual 'keypress' + expect(hotkeys.get('v').combo).toEqual ['v'] + expect(hotkeys.get('v').action).toBe undefined describe 'Platform specific things', -> beforeEach ->