library-mirrors/jquery
1
0
Fork 0
mirror of https://github.com/jquery/jquery.git synced 2024-11-23 02:54:22 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merged the three unbind docs into one, added a few more (optional) hints; Use one() instead of bind() for unload

Browse Source
This commit is contained in:
Jörn Zaefferer 2007-01-04 09:47:42 +00:00
parent e0c7e6aec4
commit df91317ab4
2 changed files with 29 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
src/event/event.js
View File

@ -265,8 +265,22 @@ jQuery.fn.extend({
/** /**
* The opposite of bind, removes a bound event from each of the matched * 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 * elements.
* bind method. *
* 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 <p onclick="alert('Hello');">Hello</p>
* @result [ <p>Hello</p> ]
*
* @example $("p").unbind( "click" )
* @before <p onclick="alert('Hello');">Hello</p>
* @result [ <p>Hello</p> ]
* *
* @example $("p").unbind( "click", function() { alert("Hello"); } ) * @example $("p").unbind( "click", function() { alert("Hello"); } )
* @before <p onclick="alert('Hello');">Hello</p> * @before <p onclick="alert('Hello');">Hello</p>
@ -274,34 +288,8 @@ jQuery.fn.extend({
* *
* @name unbind * @name unbind
* @type jQuery * @type jQuery
* @param String type An event type * @param String type (optional) An event type
* @param Function fn A function to unbind from the event on each of the set of matched elements * @param Function fn (optional) 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 <p onclick="alert('Hello');">Hello</p>
* @result [ <p>Hello</p> ]
*
* @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()
* @before <p onclick="alert('Hello');">Hello</p>
* @result [ <p>Hello</p> ]
*
* @name unbind
* @type jQuery
* @cat Events * @cat Events
*/ */
unbind: function( type, fn ) { unbind: function( type, fn ) {
@ -1090,7 +1078,7 @@ new function(){
// Clean up after IE to avoid memory leaks // Clean up after IE to avoid memory leaks
if (jQuery.browser.msie) if (jQuery.browser.msie)
jQuery(window).bind("unload", function() { jQuery(window).one("unload", function() {
var global = jQuery.event.global; var global = jQuery.event.global;
for ( var type in global ) { for ( var type in global ) {
var els = global[type], i = els.length; var els = global[type], i = els.length;

14
src/fx/fx.js
View File

@ -73,7 +73,7 @@ jQuery.fn.extend({
* *
* @name slideDown * @name slideDown
* @type jQuery * @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. * @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations * @cat Effects/Animations
* @see slideUp(String|Number,Function) * @see slideUp(String|Number,Function)
@ -98,7 +98,7 @@ jQuery.fn.extend({
* *
* @name slideUp * @name slideUp
* @type jQuery * @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. * @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations * @cat Effects/Animations
* @see slideDown(String|Number,Function) * @see slideDown(String|Number,Function)
@ -123,7 +123,7 @@ jQuery.fn.extend({
* *
* @name slideToggle * @name slideToggle
* @type jQuery * @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. * @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations * @cat Effects/Animations
* @see slideDown(String|Number,Function) * @see slideDown(String|Number,Function)
@ -152,7 +152,7 @@ jQuery.fn.extend({
* *
* @name fadeIn * @name fadeIn
* @type jQuery * @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. * @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations * @cat Effects/Animations
* @see fadeOut(String|Number,Function) * @see fadeOut(String|Number,Function)
@ -178,7 +178,7 @@ jQuery.fn.extend({
* *
* @name fadeOut * @name fadeOut
* @type jQuery * @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. * @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations * @cat Effects/Animations
* @see fadeIn(String|Number,Function) * @see fadeIn(String|Number,Function)
@ -238,8 +238,8 @@ jQuery.fn.extend({
* @name animate * @name animate
* @type jQuery * @type jQuery
* @param Hash params A set of style attributes that you wish to animate, and to what end. * @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 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 A function to be executed whenever the animation completes. * @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations * @cat Effects/Animations
*/ */
animate: function(prop,speed,callback) { animate: function(prop,speed,callback) {