burak277 / js-hotkeys Goto Github PK

What steps will reproduce the problem?
1. add text area or text field in demo
2. try to type in text area/field
3. an error for each pressing

What is the expected output? What do you see instead?
See this error:
inspector(Object type=keydown target=textarea
currentTarget=html)jquery.hotkeys.js (line 83)
handle(Object type=keydown target=textarea
currentTarget=html)jquery-1.1.4.js (line 1562)
handle()jquery-1.1.4.js (line 1441)
[Break on this error] var cbMap = that.all[element].events[type].callbackMap;


What version of the product are you using? On what operating system?
Use the latest version of hotkeys which I can download from "Downloads" page.


Please provide any additional information below.
Firefox/2.0.0.8 Win 

[deleted issue]

When using the CTRL+NUM (any number), only the Firefox works well if you
use CTRL with a key from the numeric keypad. The other browsers just
doesn't trigger what is expected.

I've removed the IF statement in the line 60 of the jquery.hotkeys-0.7.8.js
and worked fine. I think that IF statement is disabling the key combination
in the other browsers.

What steps will reproduce the problem?
1. Visit the demo page at http://jshotkeys.googlepages.com/test-static.html
2. Use the numeric keypad to enter numbers 0-9.  0 produces no result.  1-9
are recognized as lowercase letters a - i (in order), instead of the
expected numbers. 

Occurs with both IE/FireFox on Windows XP (only ones I've tested.)

Seems this could be fixed relatively easily.  Exhaustive discussion of
keycodes is given at http://unixpapa.com/js/key.html.

What steps will reproduce the problem?
1. Open the demo page in Chrome
2. Press Alt+D
3. The key is handled by the page. However, the address bar gets the focus.

What is the expected output? What do you see instead?
The address bar gets the focus. I expected the focus to stay on the page.

What version of the product are you using? On what operating system?
Chrome 1.0.154.48 on Windows XP 64

What steps will reproduce the problem?
1. Bind a keypress, keydown, or keyup event to a jquery live event
2. Bind a js-hotkeys event
3. Only one of the events will fire or neither

What is the expected output? What do you see instead?
Even when live key events are bound, js-hotkeys should still work.

What version of the product are you using? On what operating system?
0.7.8

Please provide any additional information below.  Here's the code I'm
trying to get to work:
    // this was existing working code
    $('#contentInner #main .txtRequisition').live('keypress', function(e) {
        if ((e.which && e.which == 13) || (e.keyCode && e.keyCode == 13)) {
            alert('enter pressed');
            return false;
        }
        return true;
    });

    // here's the 2 js-hotkeys events i added.  if i comment-out the
    // live handler, these work, but not otherwise.
    $(this).bind('keydown', 'f5', function(evt) {
        alert('f5');
        return false;
    });

    $(this).bind('keydown', 'Ctrl+r', function(evt) {
        alert('Ctrl+r');
        return false;
    });

Looks like a simple error...notice that the '3' is mapped twice, and '4' is
not mapped at all:

firefoxNumPad: { 96: '0', 97:'1', 98: '2', 99: '3', 100: '3', 
            101: '5', 102: '6', 103: '7', 104: '8', 105: '9' },

What steps will reproduce the problem?
1. Setup DisableInInput to true
2. Set cursor focus to an html select element
3. Press a configured keyboard shortcut

What is the expected output? What do you see instead?
I would hope that focus on select elements would disable keyboard shortcuts
if DisableInInput is true.  
Currently, the keyboard shortcut is executed.

What version of the product are you using? On what operating system?
Using commit 8275c7355b9dfda5f6cf1a7f4eba3ab358700bcb (current as of today)
from github repo.
Running Ubuntu 8.10 with Firefox 3.0.6

Please provide any additional information below.
The reasoning for this is many times keyboard users use the keyboard to
choose items in select lists (I for one) in order to speed up data entry.
Sometimes those keyboard entries to choose items in select elements can
conflict with the keyboard shortcuts configured. 

I have attached a patch the implements this change and it works for me.

I am submitting it for your approval and possible inclusion.

Best Regards,

Paul Eden

What steps will reproduce the problem?
1. First problem is I can't find a way to bind '/'. I solve it by adding an
entry in specialKeys: {
         ....
         120:'f9', 121:'f10', 122:'f11', 123:'f12',
         191:'slash'            // by vole
}
Then I can bind it by "$(document).bind('keydown', 'slash', somehandler);"
2. In Firefox, when pressed '/', the quick search bar will appear. Even
'somehandler' return false, the bar will still appear.
3. Even I add some more code at hotkeys.handler, it seems still not work
for me. Before return result, I added:                  
                    if (!result) {
                        // by vole
                        var patchE = event.originalEvent;
                        if (patchE.stopPropagation) patchE.stopPropagation( );  // DOM
model
                        if (patchE.cancelBubble) patchE.cancelBubble = true;          
       // IE model
                        if (patchE.preventDefault) patchE.preventDefault( );    // DOM
                        if (patchE.returnValue) patchE.returnValue = false;           
      // IE
                    }
                    return result;

I tried out the above code outside jQuery & jquery.hotkeys, it works for me.

What is the expected output? What do you see instead?
I want to prevent the Firefox quick search bar from appearing.
But it appears anyway.

What version of the product are you using? On what operating system?
jquery.hotkeys-0.7.8.js
jquery-1.2.6.js
Windows XP SP2
Firefox 3.0.5

Please provide any additional information below.

WinXP - Firefox 2.0.0.16

This attribute is undefined:
event.altKey

So I changed the line to this:
alt= event.originalEvent.altKey

I have no clue what this does to cross platform compatibility, but our app
runs in a closed network on Firefox 2....being selfish here!

By the way, great library, thank you!

What steps will reproduce the problem?
1. try to use 'this.something' in function call


What is the expected output? What do you see instead?
I can use 'this' to reference the caller.

Example:
foo = {
    id: 5,
    bar: function() {
        alert(this.id);
    },
    init: function() {
        uic.shortcut.add("Shift+V", this.bar, {}, this, true);
    }
}

foo.init();


What version of the product are you using? On what operating system?
current


Please provide any additional information below:
http://www.openjs.com/scripts/events/keyboard_shortcuts/

See comment of Patrick ( 28 Aug, 2007 12:49 ). He proposed a solution for 
the script on that page. It should be possible to adapt this for js-
hotkeys.

Needed to add the following line to avoid errors when event.target was an
anchor (or anything besides the HTML element)

if(!that.all || !that.all[element]) {return};

Just before this line:

var cbMap = that.all[element].events[type].callbackMap;

What steps will reproduce the problem?
1. add t
2. press f5
3. t is executed
(works fine if both t and f5 are added)
works also in the demo, just deactivate adding f5

What version of the product are you using? On what operating system?
beta 03 / Firefox 2.00.7 Winxp

A colleague asked why he couldn't get ? to get picked up by the code. I had
a look and it appears you're hard coding to US keyboard codes. We're in the
UK so letters are fine but symbols are very jumbled.

Here's some examples:

/ - 191
' - 192
# - 222

im currently using this code to enable my accesskeys and allowing my forms
to be submitted by ctrl+return if u like it please include it (just give me
some credit...) hope its readable in this form :)

    $.hotkeys = $.extend($.hotkeys,{
        /**
         * @param {Object} on - selector or jQuery Object - 'div' <-> $('div')
         * @param {Object} options
         *  modifier: Ctrl / Alt / '' ? !Shift = Capital letter! -> Ctrl + A =
Ctrl + Shift + A
         *  target: in which area is this hotkey valid ? -> html <-> div#my_form
(not recommended since it makes users crazy)
         *  type: 'keyup' / 'keypress'
         *  propagate: ??? TODO
         *  disableInInput: will not be accessible while in a input field
         * @param {Object} callback - function to call
         */
        enableAccesskeys : function(on,options,callback){
            //sanitize options
            if(!options)options={};
            options = $.extend({modifier:'Alt'},options);
            if(!options.modifier &&
options.disableInInput==undefined)options.disableInInput = true;//normal
chars work in inputs...
            if(options.modifier)options.modifier+='+';

            //create hotkeys
            $(on).each(function(){
                var key;
                var that = this;
                var self=$(this);
                if(key = self.attr('accesskey')) {
                    var combo = options.modifier+key;
                    self.attr('title',self.attr('title')||'' +'(shortcut: '+combo+')');
                    $.hotkeys.add(combo,options,function(){
                        callback.apply(that);
                    });
                };
            });
        },

        /**
         * @param {Object} modifier Ctrl / Alt / ''
         * @param {Object} inside jQuery selected elements or html element 
         */
        enableStdAccesskeys : function(modifier,inside){
            //1 or 0 parameters
            if(typeof modifier == 'object' || modifier==undefined){
                inside=inside || modifier;
                modifier='Alt';
            }

            //accesskey for inputs

$.hotkeys.enableAccesskeys($(':input',inside),{modifier:modifier},this.inputCall
back);

            //accesskey for links
            //TODO blank/self etc

$.hotkeys.enableAccesskeys($('a',inside),{modifier:modifier},this.linkCallback);
        },
        /**
         * @param {Object} inside jQuery selected elements or html element
         */
        enableFormSubmit: function(inside){
            $('form',inside).each(function(){
                var that = this;
                //so we can have multiple form callbacks
                this.toString=function(){
                    return 'Form: '+$(this).attr('action');
                }
                $.hotkeys.add('Ctrl+Return',{target:this},function(){
                    $(that).submit();
                });
            });
        },

        inputCallback:function(){
            $(this).focus();
        },

        linkCallback:function(){
            $(this).click();
            window.location=$(this).attr('href');
        }
    });

(grosser.michael.....gmail.com - pragmatiker.net)

What steps will reproduce the problem?
1. bind event to Alt+Ctrl+2
2. type an email address into a form field (@ key on spanish keyboard is gained 
by pressing 
AltGR + 2)


What is the expected output? What do you see instead?
no event should be fired but the event bound to Alt Ctrl 2 is getting called

What version of the product are you using? On what operating system?
0.7.8 - problem occurs across browsers - tested in IE7, FF2, FF3, Safari

What steps will reproduce the problem?
1. open firefox web browser
2. open test page http://jshotkeys.googlepages.com/test-static-01.html
3. hit f8

What is the expected output? What do you see instead?
Expected output: f8 hotkey triggered and displayed result on page. 
The f8 triggers yahoo widgets and displays it's window.


What version of the product are you using? On what operating system?
http://jshotkeys.googlepages.com/test-static-01.html
Testing Platform:
Mozilla/5.0 (Windows; U; Windows NT 5.1; en-GB; rv:1.9.0.4)
Gecko/2008102920 Firefox/3.0.4
Yahoo widgets 4.0.5(build 184) installed


Please provide any additional information below.
Not sure if this can be fixed within browser and is a valid bug report
regarding js-hotkeys.

imo the storing of elements needs to be enhanced, so that objects as
targets and objects+ajax loading can work

//small fix
//so we can have multiple form callbacks - on the same form(ajax loaded...)
this.toString=function(){
                    if(!this.random_name)this.random_name=Math.round(Math.random()*1000);
return 'Form: '+this.random_name+$(this).attr('action');
                }

I have a link with an image:
<li><a href="/t99bWar/busquedaFirmanteJSP/#.do" id="botonLimpiar"><img
src="/t99bfrm/images/limpiar.gif" alt="Limpiar"></a></li>

I have a click event:
$('#botonLimpiar').click(function(){$("form")[0].reset();return false;});

I have "return" key:
$.hotkeys.add('return', function(){return false;});

If i press link and then press "return" key, i get an error in Internet
Explorer 6.0.2800.1106:
that.all[...].events is null

Any idea?

PD: Sorry about my english :(
PD2: Very nice work!!

In jQuery one can do:
$(document).bind('click', foo);
$(document).bind('click', bar);

and both functions will be called when the event occur. 

This plug in should support this as well.

has the same combination to add several objects

Hitting F5 in IE does not return false.

Does not work in IE:

$(document).bind("keydown","F5",function(){
    /* do something */
    return false;
});

Does work in IE:

$(document).bind("keydown","F5",function(){
    /* do something */
    if (navigator.appVersion.indexOf('MSIE') != -1) {
        event.keyCode = 0; event.returnValue = false; }
    return false;
});

Why is this not default or how can I do this better?

This is a very, very, nice plugin :-)

Are you planning to add support for data-binding just like regular jquery
events? Its even more important with a key-event, as all of them is bound
to document.
That is the only thing I miss.

example code:

var shortcut = ['Alt+s','Ctrl+s','Alt+w','Ctrl+w']; 
for (var i in shortcut) {
  if (shortcut.hasOwnProperty(i)) {
    $(document).unbind('keydown',shortcut[i], this.send);
  }
}

jquery.hotkeys-0.7.8.js

binding of those shortcuts works.
unbinding of return (as an example) works just fine.
I didn't check if other Alt+ Ctrl+ combinations have same issues.

Tested under Firefox 3, Google Chrome, IE 7, Midori,
no errors returned by debuggers.

What steps will reproduce the problem?
1. create in cycle 10 text input boxes
2. create function which will copy selected text to textbox
3. bind Ctrl+0 to Ctrl+9 to assign this function to the textboxes
4. the problem is that you need to create 10 functions to solve this with
js-hotkeys


I suggest to add add parameter 'params' and send it to callback function
like you do with propagate:
this.all[opt.target].events[opt.type].callbackMap[combi] =  {cb: callback,
propagate:opt.propagate, params:opt.params};

Of course 'params:null' needs to be added to the default options.

This works for me.

Martin

What steps will reproduce the problem?
1. Go to the demo page using IE
2. Press Ctrl+P
3. The print dialog appears

What is the expected output? What do you see instead?
I expected the dialog NOT to appear

What version of the product are you using? On what operating system?
IE7 on Windows XP 64

Please provide any additional information below.
There is a relative easy way to fix this. The following javascript snippet 
could be inserted in the keydown listener:

// Only IE
if (window.event) {
  try { window.event.keyCode = 0; } catch(e) {/* Ignore */}
}

I want to bind some keys to an element, and then bind a wildcard to fire a
function for all the other key-codes.

Is this possible?

If not, please can you add it?

FF2 on Win XP

The latest code has moved disableInInput away from being a global
setting...nice!  However, the code that checks to see if the event was
fired from within an input field (text box in my case) incorrectly
identifies the event as being fired from the entire document.  So the
setting is never applied. 

maybe theres a better method than defining var inspector = function(event)
{ in every add, could propably save a bit of performance

btw:
structuring the code in
$.extend... style would have the benefit that it can be extended even
before hotkeys.js is loaded

(grosser.michael.....gmail.com - pragmatiker.net)

1. Go to the demo page
2. Use the number pad (0-9) and watch what keys light up.  For me, the
numbers translated to the first corresponding letters in the alphabet.

Easy to produce on demo site, I also reproduced in the latest download.  I
am using Firefox v2.0.0.16

What steps will reproduce the problem?
1. $("#anyidhere").bind("keydown","F2",someFunction);
2. Press F2, function is not called

What is the expected output? What do you see instead?


What version of the product are you using? On what operating system?
0.7.8, Windows XP, IE 7

Please provide any additional information below.
Others have reported this issue as well elsewhere

Except for propagate.

This stinks for all of the other options, especially (in my case)
disableInInput

In the documentation,

$(document).bind('keydown', {combi:'a', disableinInput: true}, fn);

should read

$(document).bind('keydown', {combi:'a', disableInInput: true}, fn);

disableinInput <> disableInInput

W.

http://code.google.com/p/js-hotkeys/issues/detail?id=20

Try it out on your demo page page.  I'm on Firefox 2.0 on WinXP...

After executing the plugin, a bunch of new global variables are added to
the global (window) object, including version, special_keys, shift_nums and
more. To test this, run Firebug and enter one of those variables (or use
window.special_keys to be more explicit).

These global variables have been added due to the use of the "this" keyword
inside the plugin:

(function (jQuery){
    this.version = '(beta)(0.0.3)';
    ...
)(jQuery);

When a JavaScript function is called without being treated as a method the
"this" keyword refers to the global "window" object, and any properties
added to it will become global variables. This is bad!

The solution should be pretty straight forward. Since "this" appears to
just be used to collect some variables together in to an object, a
different variable could be substituted instead. I suggest something like this:

(function (jQuery){
    var hotkeys = {}
    hotkeys.version = '(beta)(0.0.3)';
    ...
    ...
    jQuery.hotkeys = hotkeys;
)(jQuery);

Issue 26 http://code.google.com/p/js-hotkeys/issues/detail?id=26 claims to 
be fixed however as of version 0.7.8 there is still no support for the 
command key. I have included a very simple patch below which solves this 
problem by looking at the metaKey property of the key event object. I hope 
you will include this in a future version.

Diff against http://js-hotkeys.googlecode.com/files/jquery.hotkeys-0.7.8.js
---------------------------------------------------------------------------
184a185
>                 meta = event.metaKey,            
201c202
<                 if(!shift && !ctrl && !alt) { // No Modifiers

---
>                 if(!shift && !ctrl && !alt && !meta) { // No Modifiers
205c206
<                     // check combinations (alt|ctrl|shift+anything)

---
>                     // check combinations (alt|ctrl|shift|meta+anything)
209a211
>                     if(meta) modif += 'meta+';

What steps will reproduce the problem?

1. trying to unbind any combi

What is the expected output? What do you see instead?

expected: triggersMap[ObjName][evtName][combi] to be empty or reduced
instead:  triggersMap[ObjName][evtName][combi] accumulates 

What version of the product are you using? On what operating system?

0.7.8 packed and unpacked Mozilla Firefox 3.0.4/Linux

Please provide any additional information below.

fix is:

116:
+                     var combi = data.combi.toLowerCase(),

Nice lib, but this cost me quite some nerves. Hope i could help.

What steps will reproduce the problem?
1. Open hotkeys.html from attached archive in IE/FF (tested on IE7/FF2)
2. Click the first button, then press Ctrl + C. Alert 'II' appears
3. Click the second button, then press Ctrl + C. Nothing happens

What is the expected output? What do you see instead?
1. Alert 'I' should appear for the first button
2. Alert 'II' should appear for the second button

Looks like it's not a good idea to use hash as a storage for HTML elements.
I've written little unique ID generator and the problem has gone (standard
jQuery.data IMHO doesn't suit well for ID generation because of:

1. It pollutes elements with expando even for the case when you just need
to check whether unique id exists

2. It is being removed on unload event, so that custom components that I'm
writing cannot use destroy() method as a single-point for AJAX and page unload
)

Hi there!

Ok, maybe this not is an issue for the Hotkeys jQuery plugin, but, I am a
bit confused with this and think that someone help me. The question is
this. If you register some hotkeys as usual, that is:

$(d).bind(e, a('a'), function(){r('./post-new.php')});
$(d).bind(e, a('c'), function(){r('./comment-manage.php')});
$(d).bind(e, a('d'), function(){r('./')});

And so on... you are ok, and all work fine that is expected. But, if you
try somthing like this:

var hotkeys = {
  'a' : './post-new.php',
  'c' : './comment-manage.php',
  'd' : './'
}

for(hotkey in hotkeys){
  $(d).bind(e, a(hotkey), function(){r(hotkeys[hotkey])});
}

You obtain that the only hotkey that run is the last in the "hotkeys"
Array. Better said, that hotkeys run (a, c, d) but redirect to the same
URL: the last in the Array, corresponde to "d" hotkey. What happend? Anyone
help me please? Thanks in advance and have anice day! ;-)

I have seen the patch posted here in the past and thought of adopting it
and improving it.
planed to be in 0.7.6

Open IE to the demo page, press any of the Function keys (F1 to F12), they
all cause the default action to occur in IE.

to reproduce 
http://jshotkeys.googlepages.com/test-static-01.html

press .(del) on numpad it would select alpahbet n

Sorry, not sure where else to put this.  According to the new API:
"The plugin extends the following jQuery methods and functions:

    * $.fn.bind
    * $.fn.unbind
    * $.find 

The plugin takes over the control for bind() and unbind() methods. "

So...my question is:  What does this do to people that are currently using
jQuery and the bind, unbind and find methods?  Does it make those methods
unusable for them in their intended jQuery context?

Not a problem for me, our project is using Prototype.  More of a general
question.

Tested in Firefox 3.0.3b and Opera 9.2

I don't understand the jQuery event system yet so I haven't quite debug it
but thought I'd start by getting it into the system...

Hi,
when i traverse controls with tab key i have this error: that.all
[...].events is null.
This is the page with issue.

<html>
<head>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="jquery.hotkeys.js"></script>
<script type="text/javascript">
    function shortcuts() {
        $.hotkeys.add('f6',function(){ alert('f6'); });
        $.hotkeys.add('f7',function(){ alert('f7'); });
        $.hotkeys.add('f8',function(){ alert('f8'); });
        $.hotkeys.add('f9',function(){ alert('f9'); });
        $.hotkeys.add('esc',function(){ alert('esc'); });
    }

    $(document).ready(shortcuts);
</script>
<head>
<body>
<a href="javascript://">Link 1</a>
<br/>
<a href="javascript://">Link 2</a>
<br/>
<input type="text" />
<br/>
<input type="text" />
</body>
</html>

maybe theres a better method than defining var inspector = function(event)
{ in every add, could propably save a bit of performance

btw:
structuring the code in
$.extend... style would have the benefit that it can be extended even
before hotkeys.js is loaded

(grosser.michael.....gmail.com - pragmatiker.net)

What steps will reproduce the problem?
1. create a simple jQuery.Hotkeys enabled page with a single handler for 'n'
2. hit the 'n' key to fire the action
3. hit command-n intending to create a new browser window

What is the expected output? What do you see instead? even with 
{propagate:true}, the 
command-n key event is gobbled by the page and never passed back up to the 
browser. this 
makes pages which use jQuery.Hotkeys rather frustrating for users as their key 
commands 
appear to stop working.

What version of the product are you using? On what operating system?
safari 3.1.1 / Mac OS X 10.5.3

Please provide any additional information below.
this must be possible since the key navigation on http://ffffound.com/ uses say 
the h key yet 
command-h is still fed to the browser.

Max Tafelmayer sent me an email about this and I fixed it (0.7.1)
thank you max

What steps will reproduce the problem?
1. Visible on live demo

What is the expected output? What do you see instead?
I expect a + or - field to turn blue (although they aren't there anyway),
but get m and n instead.

What version of the product are you using? On what operating system?
The version used in the live demo.
OS: Windows XP
Browsers: IE7 and FF3

Please provide any additional information below.
-

What steps will reproduce the problem?
1. Work with jQuery 1.2.1

What is the expected output? What do you see instead?
Output> element.attachEvent is not a function, in jquery.js line 1636

What version of the product are you using? On what operating system?
version 0.0.3 on windows xp


Please provide any additional information below.