Fixed a bunch of endline issues.

[jquery.git] / src / fx / fx.js

diff --git a/src/fx/fx.js b/src/fx/fx.js
index 3df95de..fe1c1e2 100644 (file)
--- a/src/fx/fx.js
+++ b/src/fx/fx.js
@@ -142,10 +142,39 @@ jQuery.fn.extend({
                return this.animate({height: "hide"}, speed, callback);
        },
 
+       /**
+        * Toggle the visibility of all matched elements by adjusting their height.
+        * Only the height is adjusted for this animation, causing all matched
+        * elements to be hidden in a "sliding" manner.
+        *
+        * @example $("p").slideToggle("slow");
+        *
+        * @name slideToggle
+        * @type jQuery
+        * @param Object 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).
+        * @cat Effects/Animations
+        */
+        
+       /**
+        * Toggle the visibility of all matched elements by adjusting their height
+        * and firing a callback function after completion.
+        * Only the height is adjusted for this animation, causing all matched
+        * elements to be hidden in a "sliding" manner.
+        *
+        * @example $("p").slideToggle("slow",function(){
+        *   alert("Animation Done.");
+        * });
+        *
+        * @name slideToggle
+        * @type jQuery
+        * @param Object 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.
+        * @cat Effects/Animations
+        */
        slideToggle: function(speed,callback){
                return this.each(function(){
-                       var state = $(this).is(":hidden") ? "show" : "hide";
-                       $(this).animate({height: state}, speed, callback);
+                       var state = jQuery(this).is(":hidden") ? "show" : "hide";
+                       jQuery(this).animate({height: state}, speed, callback);
                });
        },
        
@@ -257,7 +286,31 @@ jQuery.fn.extend({
        },
        
        /**
-        * @private
+        * 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").
+        *
+        * 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
+        * animation will be constructed for that property.
+        *
+        * @example $("p").animate({
+        *   height: 'toggle', opacity: 'toggle'
+        * }, "slow");
+        *
+        * @example $("p").animate({
+        *   left: 50, opacity: 'show'
+        * }, 500);
+        *
+        * @name animate
+        * @type jQuery
+        * @param Hash params A set of style attributes that you wish to animate, and to what end.
+        * @param Object 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.
+        * @cat Effects/Animations
         */
        animate: function(prop,speed,callback) {
                return this.queue(function(){
@@ -394,16 +447,10 @@ jQuery.extend({
                z.a = function(){
                        if ( options.step )
                                options.step.apply( elem, [ z.now ] );
-
-                       if ( prop == "opacity" ) {
-                               if (jQuery.browser.mozilla && z.now == 1) z.now = 0.9999;
-                               if (window.ActiveXObject)
-                                       y.filter = "alpha(opacity=" + z.now*100 + ")";
-                               else
-                                       y.opacity = z.now;
-
-                       // My hate for IE will never die
-                       } else if ( parseInt(z.now) )
+ 
+                       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
                                y[prop] = parseInt(z.now) + "px";
                                
                        y.display = "block";
@@ -437,8 +484,12 @@ jQuery.extend({
 
                        // Remember where we started, so that we can go back to it later
                        z.el.orig[prop] = this.cur();
-
-                       z.custom( 0, z.el.orig[prop] );
+                       
+                       // Begin the animation
+                       if (prop == "opacity")
+                               z.custom(z.el.orig[prop], 1);
+                       else
+                               z.custom(0, z.el.orig[prop]);
 
                        // Stupid IE, look what you made me do
                        if ( prop != "opacity" )
@@ -458,10 +509,6 @@ jQuery.extend({
                        z.custom(z.el.orig[prop], 0);
                };
        
-               // IE has trouble with opacity if it does not have layout
-               if ( jQuery.browser.msie && !z.el.currentStyle.hasLayout )
-                       y.zoom = "1";
-       
                // Remember  the overflow of the element
                if ( !z.el.oldOverlay )
                        z.el.oldOverflow = jQuery.css( z.el, "overflow" );
@@ -499,7 +546,10 @@ jQuery.extend({
                                        // Reset the property, if the item has been hidden
                                        if ( z.o.hide ) {
                                                for ( var p in z.el.curAnim ) {
-                                                       y[ p ] = z.el.orig[p] + ( p == "opacity" ? "" : "px" );
+                                                       if (p == "opacity" && jQuery.browser.msie)
+                                                               jQuery.attr(y, p, z.el.orig[p]);
+                                                       else
+                                                               y[ p ] = z.el.orig[p] + "px";
        
                                                        // set its height and/or width to auto
                                                        if ( p == 'height' || p == 'width' )