Backported wiki changes from http://docs.jquery.com/API/1.1.1/Effects
[jquery.git] / src / fx / fx.js
index e39ea7b..a16b0a5 100644 (file)
@@ -34,7 +34,7 @@ jQuery.fn.extend({
         */
        show: function(speed,callback){
                var hidden = this.filter(":hidden");
-               return speed ?
+               speed ?
                        hidden.animate({
                                height: "show", width: "show", opacity: "show"
                        }, speed, callback) :
@@ -44,6 +44,7 @@ jQuery.fn.extend({
                                if ( jQuery.css(this,"display") == "none" )
                                        this.style.display = "block";
                        });
+               return this;
        },
        
        /**
@@ -80,7 +81,7 @@ jQuery.fn.extend({
         */
        hide: function(speed,callback){
                var visible = this.filter(":visible");
-               return speed ?
+               speed ?
                        visible.animate({
                                height: "hide", width: "hide", opacity: "hide"
                        }, speed, callback) :
@@ -91,6 +92,7 @@ jQuery.fn.extend({
                                        this.oldblock = "block";
                                this.style.display = "none";
                        });
+               return this;
        },
 
        // Save the old toggle function
@@ -277,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({
@@ -411,9 +416,6 @@ jQuery.extend({
                // 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";
 
@@ -426,6 +428,8 @@ jQuery.extend({
                                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"; // Set display property to block for animation
                };
 
                // Figure out the maximum number to run to