Simplified the easing options - we now provide "swing" and "linear" (defaulting to...
[jquery.git] / src / fx / fx.js
index d83bf0d..0c57ef4 100644 (file)
@@ -112,11 +112,12 @@ jQuery.fn.extend({
         * @cat Effects
         */
        toggle: function( fn, fn2 ){
-               return fn ?
+               var args = arguments;
+               return jQuery.isFunction(fn) && jQuery.isFunction(fn2) ?
                        this._toggle( fn, fn2 ) :
                        this.each(function(){
                                jQuery(this)[ jQuery(this).is(":hidden") ? "show" : "hide" ]
-                                       .apply( jQuery(this), arguments );
+                                       .apply( jQuery(this), args );
                        });
        },
        
@@ -142,7 +143,7 @@ jQuery.fn.extend({
         * @see slideToggle(String|Number,Function)
         */
        slideDown: function(speed,callback){
-               return this.animate({height: "show"}, speed, callback);
+               return this.filter(":hidden").animate({height: "show"}, speed, callback).end();
        },
        
        /**
@@ -167,7 +168,7 @@ jQuery.fn.extend({
         * @see slideToggle(String|Number,Function)
         */
        slideUp: function(speed,callback){
-               return this.animate({height: "hide"}, speed, callback);
+               return this.filter(":visible").animate({height: "hide"}, speed, callback).end();
        },
 
        /**
@@ -221,7 +222,7 @@ jQuery.fn.extend({
         * @see fadeTo(String|Number,Number,Function)
         */
        fadeIn: function(speed, callback){
-               return this.animate({opacity: "show"}, speed, callback);
+               return this.filter(":hidden").animate({opacity: "show"}, speed, callback).end();
        },
        
        /**
@@ -247,7 +248,7 @@ jQuery.fn.extend({
         * @see fadeTo(String|Number,Number,Function)
         */
        fadeOut: function(speed, callback){
-               return this.animate({opacity: "hide"}, speed, callback);
+               return this.filter(":visible").animate({opacity: "hide"}, speed, callback).end();
        },
        
        /**
@@ -278,15 +279,18 @@ jQuery.fn.extend({
        },
        
        /**
-        * A function for making your own, custom, animations. The key aspect of
+        * A function for making your own, custom animations. The key aspect of
         * this function is the object of style properties that will be animated,
         * and to what end. Each key within the object represents a style property
         * that will also be animated (for example: "height", "top", or "opacity").
         *
+        * Note that properties should be specified using camel case
+        * eg. marginLeft instead of margin-left.
+        *
         * The value associated with the key represents to what end the property
         * will be animated. If a number is provided as the value, then the style
         * property will be transitioned from its current state to that new number.
-        * Oterwise if the string "hide", "show", or "toggle" is provided, a default
+        * Otherwise if the string "hide", "show", or "toggle" is provided, a default
         * animation will be constructed for that property.
         *
         * @example $("p").animate({
@@ -306,7 +310,7 @@ jQuery.fn.extend({
         * @type jQuery
         * @param Hash params A set of style attributes that you wish to animate, and to what end.
         * @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 String easing (optional) The name of the easing effect that you want to use (Plugin Required).
+        * @param String easing (optional) The name of the easing effect that you want to use (e.g. swing or linear). Defaults to "swing".
         * @param Function callback (optional) A function to be executed whenever the animation completes.
         * @cat Effects
         */
@@ -358,9 +362,9 @@ jQuery.extend({
        speed: function(speed, easing, fn) {
                var opt = speed && speed.constructor == Object ? speed : {
                        complete: fn || !fn && easing || 
-                               speed && speed.constructor == Function && speed,
+                               jQuery.isFunction( speed ) && speed,
                        duration: speed,
-                       easing: fn && easing || easing && easing.constructor != Function && easing
+                       easing: fn && easing || easing && easing.constructor != Function && easing || "swing"
                };
 
                opt.duration = (opt.duration && opt.duration.constructor == Number ? 
@@ -368,17 +372,24 @@ jQuery.extend({
                        { slow: 600, fast: 200 }[opt.duration]) || 400;
        
                // Queueing
-               opt.oldComplete = opt.complete;
+               opt.old = opt.complete;
                opt.complete = function(){
                        jQuery.dequeue(this, "fx");
-                       if ( opt.oldComplete && opt.oldComplete.constructor == Function )
-                               opt.oldComplete.apply( this );
+                       if ( jQuery.isFunction( opt.old ) )
+                               opt.old.apply( this );
                };
        
                return opt;
        },
        
-       easing: {},
+       easing: {
+               linear: function( p, n, firstNum, diff ) {
+                       return firstNum + diff * p;
+               },
+               swing: function( p, n, firstNum, diff ) {
+                       return ((-Math.cos(p*Math.PI)/2) + 0.5) * diff + firstNum;
+               }
+       },
        
        queue: {},
        
@@ -396,6 +407,8 @@ jQuery.extend({
                }
        },
 
+       timers: [],
+
        /*
         * I originally wrote fx() as a clone of moo.fx and in the process
         * of making it small in size the code became illegible to sane
@@ -409,12 +422,14 @@ jQuery.extend({
                // The styles
                var y = elem.style;
                
-               // Store display property
-               var oldDisplay = jQuery.css(elem, 'display');
-               // Set display property to block for animation
-               y.display = "block";
-               // Make sure that nothing sneaks out
-               y.overflow = "hidden";
+               if ( prop == "height" || prop == "width" ) {
+                       // Store display property
+                       var oldDisplay = jQuery.css(elem, "display");
+
+                       // Make sure that nothing sneaks out
+                       var oldOverflow = y.overflow;
+                       y.overflow = "hidden";
+               }
 
                // Simple function for setting a style value
                z.a = function(){
@@ -423,8 +438,10 @@ jQuery.extend({
 
                        if ( prop == "opacity" )
                                jQuery.attr(y, "opacity", z.now); // Let attr handle opacity
-                       else if ( parseInt(z.now) ) // My hate for IE will never die
+                       else {
                                y[prop] = parseInt(z.now) + "px";
+                               y.display = "block"; // Set display property to block for animation
+                       }
                };
 
                // Figure out the maximum number to run to
@@ -444,9 +461,20 @@ jQuery.extend({
                        z.now = from;
                        z.a();
 
-                       z.timer = setInterval(function(){
-                               z.step(from, to);
-                       }, 13);
+                       jQuery.timers.push(function(){
+                               return z.step(from, to);
+                       });
+
+                       if ( jQuery.timers.length == 1 ) {
+                               var timer = setInterval(function(){
+                                       jQuery.timers = jQuery.grep( jQuery.timers, function(fn){
+                                               return fn();
+                                       });
+
+                                       if ( !jQuery.timers.length )
+                                               clearInterval( timer );
+                               }, 13);
+                       }
                };
 
                // Simple 'show' function
@@ -454,12 +482,12 @@ jQuery.extend({
                        if ( !elem.orig ) elem.orig = {};
 
                        // Remember where we started, so that we can go back to it later
-                       elem.orig[prop] = this.cur();
+                       elem.orig[prop] = jQuery.attr( elem.style, prop );
 
                        options.show = true;
 
                        // Begin the animation
-                       z.custom(0, elem.orig[prop]);
+                       z.custom(0, this.cur());
 
                        // Stupid IE, look what you made me do
                        if ( prop != "opacity" )
@@ -471,12 +499,12 @@ jQuery.extend({
                        if ( !elem.orig ) elem.orig = {};
 
                        // Remember where we started, so that we can go back to it later
-                       elem.orig[prop] = this.cur();
+                       elem.orig[prop] = jQuery.attr( elem.style, prop );
 
                        options.hide = true;
 
                        // Begin the animation
-                       z.custom(elem.orig[prop], 0);
+                       z.custom(this.cur(), 0);
                };
                
                //Simple 'toggle' function
@@ -484,9 +512,9 @@ jQuery.extend({
                        if ( !elem.orig ) elem.orig = {};
 
                        // Remember where we started, so that we can go back to it later
-                       elem.orig[prop] = this.cur();
+                       elem.orig[prop] = jQuery.attr( elem.style, prop );
 
-                       if(oldDisplay == 'none')  {
+                       if(oldDisplay == "none")  {
                                options.show = true;
                                
                                // Stupid IE, look what you made me do
@@ -494,12 +522,12 @@ jQuery.extend({
                                        y[prop] = "1px";
 
                                // Begin the animation
-                               z.custom(0, elem.orig[prop]);   
+                               z.custom(0, this.cur());        
                        } else {
                                options.hide = true;
 
                                // Begin the animation
-                               z.custom(elem.orig[prop], 0);
+                               z.custom(this.cur(), 0);
                        }               
                };
 
@@ -508,10 +536,6 @@ jQuery.extend({
                        var t = (new Date()).getTime();
 
                        if (t > options.duration + z.startTime) {
-                               // Stop the timer
-                               clearInterval(z.timer);
-                               z.timer = null;
-
                                z.now = lastNum;
                                z.a();
 
@@ -523,45 +547,45 @@ jQuery.extend({
                                                done = false;
 
                                if ( done ) {
-                                       // Reset the overflow
-                                       y.overflow = '';
+                                       if ( oldDisplay ) {
+                                               // Reset the overflow
+                                               y.overflow = oldOverflow;
                                        
-                                       // Reset the display
-                                       y.display = oldDisplay;
-                                       if (jQuery.css(elem, 'display') == 'none')
-                                               y.display = 'block';
+                                               // Reset the display
+                                               y.display = oldDisplay;
+                                               if (jQuery.css(elem, "display") == "none")
+                                                       y.display = "block";
+                                       }
 
                                        // Hide the element if the "hide" operation was done
                                        if ( options.hide ) 
-                                               y.display = 'none';
+                                               y.display = "none";
 
                                        // Reset the properties, if the item has been hidden or shown
                                        if ( options.hide || options.show )
                                                for ( var p in elem.curAnim )
-                                                       if (p == "opacity")
-                                                               jQuery.attr(y, p, elem.orig[p]);
-                                                       else
-                                                               y[p] = '';
+                                                       jQuery.attr(y, p, elem.orig[p]);
                                }
 
                                // If a callback was provided, execute it
-                               if ( done && options.complete && options.complete.constructor == Function )
+                               if ( done && jQuery.isFunction( options.complete ) )
                                        // Execute the complete function
                                        options.complete.apply( elem );
+
+                               return false;
                        } else {
                                var n = t - this.startTime;
                                // Figure out where in the animation we are and set the number
                                var p = n / options.duration;
                                
-                               // If the easing function exists, then use it 
-                               z.now = options.easing && jQuery.easing[options.easing] ?
-                                       jQuery.easing[options.easing](p, n,  firstNum, (lastNum-firstNum), options.duration) :
-                                       // else use default linear easing
-                                       ((-Math.cos(p*Math.PI)/2) + 0.5) * (lastNum-firstNum) + firstNum;
+                               // Perform the easing function, defaults to swing
+                               z.now = jQuery.easing[options.easing](p, n,  firstNum, (lastNum-firstNum), options.duration);
 
                                // Perform the next step of the animation
                                z.a();
                        }
+
+                       return true;
                };
        
        }