From df91317ab43254bb0095482c49de080f5cf4f89e Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=B6rn=20Zaefferer?= Date: Thu, 4 Jan 2007 09:47:42 +0000 Subject: [PATCH] Merged the three unbind docs into one, added a few more (optional) hints; Use one() instead of bind() for unload --- src/event/event.js | 38 +++++++++++++------------------------- src/fx/fx.js | 20 ++++++++++---------- 2 files changed, 23 insertions(+), 35 deletions(-) diff --git a/src/event/event.js b/src/event/event.js index ac6948046..eaf6858c5 100644 --- a/src/event/event.js +++ b/src/event/event.js @@ -265,43 +265,31 @@ jQuery.fn.extend({ /** * The opposite of bind, removes a bound event from each of the matched - * elements. You must pass the identical function that was used in the original - * bind method. + * elements. * - * @example $("p").unbind( "click", function() { alert("Hello"); } ) + * Without any arguments, all bound events are removed. + * + * If the type is provided, all bound events of that type are removed. + * + * If the function that was passed to bind is provided as the second argument, + * only that specific event handler is removed. + * + * @example $("p").unbind() * @before

Hello

* @result [

Hello

] * - * @name unbind - * @type jQuery - * @param String type An event type - * @param Function fn A function to unbind from the event on each of the set of matched elements - * @cat Events - */ - - /** - * Removes all bound events of a particular type from each of the matched - * elements. - * * @example $("p").unbind( "click" ) * @before

Hello

* @result [

Hello

] * - * @name unbind - * @type jQuery - * @param String type An event type - * @cat Events - */ - - /** - * Removes all bound events from each of the matched elements. - * - * @example $("p").unbind() + * @example $("p").unbind( "click", function() { alert("Hello"); } ) * @before

Hello

* @result [

Hello

] * * @name unbind * @type jQuery + * @param String type (optional) An event type + * @param Function fn (optional) A function to unbind from the event on each of the set of matched elements * @cat Events */ unbind: function( type, fn ) { @@ -1090,7 +1078,7 @@ new function(){ // Clean up after IE to avoid memory leaks if (jQuery.browser.msie) - jQuery(window).bind("unload", function() { + jQuery(window).one("unload", function() { var global = jQuery.event.global; for ( var type in global ) { var els = global[type], i = els.length; diff --git a/src/fx/fx.js b/src/fx/fx.js index 4f81aca13..dd72c6505 100644 --- a/src/fx/fx.js +++ b/src/fx/fx.js @@ -73,7 +73,7 @@ jQuery.fn.extend({ * * @name slideDown * @type jQuery - * @param String|Number speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). + * @param String|Number speed (optional) A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). * @param Function callback (optional) A function to be executed whenever the animation completes. * @cat Effects/Animations * @see slideUp(String|Number,Function) @@ -98,7 +98,7 @@ jQuery.fn.extend({ * * @name slideUp * @type jQuery - * @param String|Number speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). + * @param String|Number speed (optional) A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). * @param Function callback (optional) A function to be executed whenever the animation completes. * @cat Effects/Animations * @see slideDown(String|Number,Function) @@ -123,13 +123,13 @@ jQuery.fn.extend({ * * @name slideToggle * @type jQuery - * @param String|Number speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). + * @param String|Number speed (optional) A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). * @param Function callback (optional) A function to be executed whenever the animation completes. * @cat Effects/Animations * @see slideDown(String|Number,Function) * @see slideUp(String|Number,Function) */ - slideToggle: function(speed,callback){ + slideToggle: function(speed, callback){ return this.each(function(){ var state = jQuery(this).is(":hidden") ? "show" : "hide"; jQuery(this).animate({height: state}, speed, callback); @@ -152,13 +152,13 @@ jQuery.fn.extend({ * * @name fadeIn * @type jQuery - * @param String|Number speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). + * @param String|Number speed (optional) A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). * @param Function callback (optional) A function to be executed whenever the animation completes. * @cat Effects/Animations * @see fadeOut(String|Number,Function) * @see fadeTo(String|Number,Number,Function) */ - fadeIn: function(speed,callback){ + fadeIn: function(speed, callback){ return this.animate({opacity: "show"}, speed, callback); }, @@ -178,13 +178,13 @@ jQuery.fn.extend({ * * @name fadeOut * @type jQuery - * @param String|Number speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). + * @param String|Number speed (optional) A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). * @param Function callback (optional) A function to be executed whenever the animation completes. * @cat Effects/Animations * @see fadeIn(String|Number,Function) * @see fadeTo(String|Number,Number,Function) */ - fadeOut: function(speed,callback){ + fadeOut: function(speed, callback){ return this.animate({opacity: "hide"}, speed, callback); }, @@ -238,8 +238,8 @@ jQuery.fn.extend({ * @name animate * @type jQuery * @param Hash params A set of style attributes that you wish to animate, and to what end. - * @param String|Number speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). - * @param Function callback A function to be executed whenever the animation completes. + * @param String|Number speed (optional) A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). + * @param Function callback (optional) A function to be executed whenever the animation completes. * @cat Effects/Animations */ animate: function(prop,speed,callback) { -- 2.39.5