jQuery's Event Triggering, Order Of Default Behavior, And triggerHandler()

Posted March 12, 2009 at 10:20 AM

Tags: Javascript / DHTML

I ran into a strange, rather undesirable behavior this morning when dealing with jQuery's manual event triggering. It seems that when you trigger the click event on a checkbox, the default behavior (toggling the checked attribute) takes place after event handlers fire. This is opposite of what happens when the browser naturally handles the checkbox click event - the checked attribute is toggled and then the event handlers are executed.

This difference in the order of operations between inherent clicking and jQuery's event triggering can cause a big problem if the event handler depends on the status of checkbox in anyway (which, if you have a click handler on a checkbox to begin with means it probably does).

To see this in action, take a look at this simple code:

 Launch code in new window » Download code as text file »

  • <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  • <html>
  • <head>
  • <title>jQuery Trigger and Default Behavior Demo</title>
  •  
  • <script type="text/javascript" src="jquery-1.3.2.js"></script>
  • <script type="text/javascript">
  •  
  • // When the DOM is ready, initialize.
  • $(
  • function(){
  •  
  • $( "input" ).click(
  • function( objEvent ){
  •  
  • // Alert the checkboxed status.
  • alert( this.checked );
  •  
  • }
  • );
  •  
  •  
  • $( "button" ).click(
  • function( objEvent ){
  •  
  • // Trigger click on the checkbox.
  • $( "input" ).click();
  •  
  • }
  • );
  •  
  • }
  • );
  •  
  • </script>
  • </head>
  • <body>
  •  
  • <h1>
  • jQuery Trigger and Default Behavior Demo
  • </h1>
  •  
  • <form>
  • <input type="checkbox" />
  • <button>click checkbox</button>
  • </form>
  •  
  • </body>
  • </html>

If I refresh this above code and click on the checkbox directly, it alerts:

true

... because the checkbox's checked attribute is toggled before the click handler executes. If, however, I refresh the page (hard refresh to reset form) and click on the button to manually trigger the click handler on the checkbox, it alerts:

false

This is because the manually triggered event handlers fire before the default behavior takes place.

To get around this, I had to manually change the checkbox and then trigger ONLY the event handlers:

 Launch code in new window » Download code as text file »

  • <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  • <html>
  • <head>
  • <title>jQuery Trigger and Default Behavior Demo</title>
  •  
  • <script type="text/javascript" src="jquery-1.3.2.js"></script>
  • <script type="text/javascript">
  •  
  • // When the DOM is ready, initialize.
  • $(
  • function(){
  •  
  • $( "input" ).click(
  • function( objEvent ){
  •  
  • // Alert the checkboxed status.
  • alert( this.checked );
  •  
  • }
  • );
  •  
  •  
  • $( "button" ).click(
  • function( objEvent ){
  •  
  • // Toggle checkbox checked status.
  • $( "input" )[ 0 ].checked = !$( "input" )[ 0 ].checked;
  •  
  • // Trigger ONLY click event hanlders on the checkbox.
  • $( "input" ).triggerHandler( "click" );
  •  
  • }
  • );
  •  
  • }
  • );
  •  
  • </script>
  • </head>
  • <body>
  •  
  • <h1>
  • jQuery Trigger and Default Behavior Demo
  • </h1>
  •  
  • <form>
  • <input type="checkbox" />
  • <button>click checkbox</button>
  • </form>
  •  
  • </body>
  • </html>

jQuery's triggerHandler() method allows us to trigger the jQuery-bound event handlers without triggering the default behavior of the browser (toggle checked status). In doing so, the click handler on the checkbox itself can now function uniformly no matter how it is triggered.

I love jQuery event binding and triggering; I think this is the only place where this anomaly will actually matter as this is the only event type that I can think of that has to change the DOM before it executes its handlers.

Download Code Snippet ZIP File

Post Comment  |  Ask Ben  |  Permalink  |  Other Searches  |  Print Page




Learning ColdFusion 9 - ColdFusion 9 tutorials, samples, examples, demos

Reader Comments

Mar 18, 2009 at 10:18 AM // reply »
1 Comments

Hi,

Thanks I think that's exactly what I need. I guess nobody is aware of a jQuery plugin solution to this problem so far?


Mar 21, 2009 at 5:58 AM // reply »
1 Comments

Hi,

Thanks for sharing this precious information, I was banging my head against the wall to solve this nagging problem. I think that's exactly what I needed.

Thanks once again!

Mohammed.


Mar 21, 2009 at 2:00 PM // reply »
6,516 Comments

@Mohammed,

Glad to help out :)


Mar 28, 2009 at 6:51 AM // reply »
2 Comments

another way:

$(document).ready(function(e){
$("body").append("<input type='checkbox'/>");

$(":checkbox").click(function(e){
this.checked=!this.checked;
}).click(function(e){
alert(this.checked);
}).click(function(e){
this.checked=!this.checked;
});

$("body").append("<input type='button' value='toggle'/>");
$(":button").click(function(e){
$(":checkbox").click();
});
});


Mar 28, 2009 at 6:56 AM // reply »
2 Comments

sorry,it seems not work correctly when actually click the checkbox.


Aug 28, 2009 at 10:29 AM // reply »
1 Comments

Exactly the information I was looking for.

Toggling the checked state, then using triggerHandler() worked perfectly.

Thanks for this.


Sep 2, 2009 at 9:38 AM // reply »
6,516 Comments

@llade,

No worries my man. It's a weird situation.

@Jeff,

Glad to help out.


Post Comment  |  Ask Ben

Recent Blog Comments
aha
Nov 22, 2009 at 7:42 AM
Using A Name Suffix In ColdFusion's CFMail Tag
Why not? ... read »
Nov 22, 2009 at 7:37 AM
Using A Name Suffix In ColdFusion's CFMail Tag
asd ... read »
Nov 22, 2009 at 4:30 AM
jQuery Live() Method And Event Bubbling
dasegtezr ... read »
Nov 22, 2009 at 4:03 AM
jQuery Live() Method And Event Bubbling
C_fieri ... read »
Nov 22, 2009 at 1:56 AM
Learning ColdFusion 9: Using CFQuery In CFScript Can Enable SQL Injection Attacks
Why adobe would give you script equivalent of cfquery is beyond me. I love cfquery tag because it helps me wriite clean sql, and get away from the horrible jdbc queries If I wanted to write javali ... read »
Nov 22, 2009 at 1:45 AM
Streaming Text Using ColdFusion's CFContent Tag And The Variable Attribute
The reason you would want to do this is to stream. Ack json/xml files to ria clients I used thus technique before because putting json in response stream causes debugging info to come thru As well a ... read »
Nov 21, 2009 at 6:47 PM
Hal Helms - Real World Object Oriented Development, Sarasota - Day Five
@charlie griefer, Thank you.. ... read »
Nov 21, 2009 at 5:15 PM
Using ColdFusion Structures To Remove Duplicate List Values
@Jose Galdamez, Oh heh yeah I didn't paste the whole code. I should have defined the vars -- my bad. It's fixed thou. Thanks. ... read »