X-Git-Url: http://git.asbjorn.it/?a=blobdiff_plain;ds=inline;f=src%2Ffx%2Ffx.js;h=4c38413ef374b5fee88b1fa43fba83b6a845ae17;hb=28a80202b3d41ed69f529f91c2f5bc4e929d51fa;hp=1dfd31e5f2804029b44f63af2f7d7cf03f083d11;hpb=7b2c84ddbe004ed4ab2ee3982af40b7275d7dfde;p=jquery.git diff --git a/src/fx/fx.js b/src/fx/fx.js index 1dfd31e..4c38413 100644 --- a/src/fx/fx.js +++ b/src/fx/fx.js @@ -1,580 +1,577 @@ -jQuery.fn.extend({ - - // overwrite the old show method - _show: jQuery.fn.show, - - /** - * Show all matched elements using a graceful animation. - * The height, width, and opacity of each of the matched elements - * are changed dynamically according to the specified speed. - * - * @example $("p").show("slow"); - * - * @name show - * @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 - */ - - /** - * Show all matched elements using a graceful animation and firing a callback - * function after completion. - * The height, width, and opacity of each of the matched elements - * are changed dynamically according to the specified speed. - * - * @example $("p").show("slow",function(){ - * alert("Animation Done."); - * }); - * - * @name show - * @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 - */ - show: function(speed,callback){ - return speed ? this.animate({ - height: "show", width: "show", opacity: "show" - }, speed, callback) : this._show(); - }, - - // Overwrite the old hide method - _hide: jQuery.fn.hide, - - /** - * Hide all matched elements using a graceful animation. - * The height, width, and opacity of each of the matched elements - * are changed dynamically according to the specified speed. - * - * @example $("p").hide("slow"); - * - * @name hide - * @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 - */ - - /** - * Hide all matched elements using a graceful animation and firing a callback - * function after completion. - * The height, width, and opacity of each of the matched elements - * are changed dynamically according to the specified speed. - * - * @example $("p").hide("slow",function(){ - * alert("Animation Done."); - * }); - * - * @name hide - * @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 - */ - hide: function(speed,callback){ - return speed ? this.animate({ - height: "hide", width: "hide", opacity: "hide" - }, speed, callback) : this._hide(); - }, - - /** - * Reveal all matched elements by adjusting their height. - * Only the height is adjusted for this animation, causing all matched - * elements to be revealed in a "sliding" manner. - * - * @example $("p").slideDown("slow"); - * - * @name slideDown - * @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 - */ - - /** - * Reveal 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 revealed in a "sliding" manner. - * - * @example $("p").slideDown("slow",function(){ - * alert("Animation Done."); - * }); - * - * @name slideDown - * @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 - */ - slideDown: function(speed,callback){ - return this.animate({height: "show"}, speed, callback); - }, - - /** - * Hide 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").slideUp("slow"); - * - * @name slideUp - * @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 - */ - - /** - * Hide 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").slideUp("slow",function(){ - * alert("Animation Done."); - * }); - * - * @name slideUp - * @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 - */ - slideUp: function(speed,callback){ - 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 = jQuery(this).is(":hidden") ? "show" : "hide"; - jQuery(this).animate({height: state}, speed, callback); - }); - }, - - /** - * Fade in all matched elements by adjusting their opacity. - * Only the opacity is adjusted for this animation, meaning that - * all of the matched elements should already have some form of height - * and width associated with them. - * - * @example $("p").fadeIn("slow"); - * - * @name fadeIn - * @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 - */ - - /** - * Fade in all matched elements by adjusting their opacity and firing a - * callback function after completion. - * Only the opacity is adjusted for this animation, meaning that - * all of the matched elements should already have some form of height - * and width associated with them. - * - * @example $("p").fadeIn("slow",function(){ - * alert("Animation Done."); - * }); - * - * @name fadeIn - * @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 - */ - fadeIn: function(speed,callback){ - return this.animate({opacity: "show"}, speed, callback); - }, - - /** - * Fade out all matched elements by adjusting their opacity. - * Only the opacity is adjusted for this animation, meaning that - * all of the matched elements should already have some form of height - * and width associated with them. - * - * @example $("p").fadeOut("slow"); - * - * @name fadeOut - * @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 - */ - - /** - * Fade out all matched elements by adjusting their opacity and firing a - * callback function after completion. - * Only the opacity is adjusted for this animation, meaning that - * all of the matched elements should already have some form of height - * and width associated with them. - * - * @example $("p").fadeOut("slow",function(){ - * alert("Animation Done."); - * }); - * - * @name fadeOut - * @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 - */ - fadeOut: function(speed,callback){ - return this.animate({opacity: "hide"}, speed, callback); - }, - - /** - * Fade the opacity of all matched elements to a specified opacity. - * Only the opacity is adjusted for this animation, meaning that - * all of the matched elements should already have some form of height - * and width associated with them. - * - * @example $("p").fadeTo("slow", 0.5); - * - * @name fadeTo - * @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 Number opacity The opacity to fade to (a number from 0 to 1). - * @cat Effects/Animations - */ - - /** - * Fade the opacity of all matched elements to a specified opacity and - * firing a callback function after completion. - * Only the opacity is adjusted for this animation, meaning that - * all of the matched elements should already have some form of height - * and width associated with them. - * - * @example $("p").fadeTo("slow", 0.5, function(){ - * alert("Animation Done."); - * }); - * - * @name fadeTo - * @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 Number opacity The opacity to fade to (a number from 0 to 1). - * @param Function callback A function to be executed whenever the animation completes. - * @cat Effects/Animations - */ - fadeTo: function(speed,to,callback){ - return this.animate({opacity: to}, speed, callback); - }, - - /** - * 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(){ - - this.curAnim = prop; - - for ( var p in prop ) { - var e = new jQuery.fx( this, jQuery.speed(speed,callback), p ); - if ( prop[p].constructor == Number ) - e.custom( e.cur(), prop[p] ); - else - e[ prop[p] ]( prop ); - } - - }); - }, - - /** - * - * @private - */ - queue: function(type,fn){ - if ( !fn ) { - fn = type; - type = "fx"; - } - - return this.each(function(){ - if ( !this.queue ) - this.queue = {}; - - if ( !this.queue[type] ) - this.queue[type] = []; - - this.queue[type].push( fn ); - - if ( this.queue[type].length == 1 ) - fn.apply(this); - }); - } - -}); - -jQuery.extend({ - - setAuto: function(e,p) { - if ( e.notAuto ) return; - - if ( p == "height" && e.scrollHeight != parseInt(jQuery.curCSS(e,p)) ) return; - if ( p == "width" && e.scrollWidth != parseInt(jQuery.curCSS(e,p)) ) return; - - // Remember the original height - var a = e.style[p]; - - // Figure out the size of the height right now - var o = jQuery.curCSS(e,p,1); - - if ( p == "height" && e.scrollHeight != o || - p == "width" && e.scrollWidth != o ) return; - - // Set the height to auto - e.style[p] = e.currentStyle ? "" : "auto"; - - // See what the size of "auto" is - var n = jQuery.curCSS(e,p,1); - - // Revert back to the original size - if ( o != n && n != "auto" ) { - e.style[p] = a; - e.notAuto = true; - } - }, - - speed: function(s,o) { - o = o || {}; - - if ( o.constructor == Function ) - o = { complete: o }; - - var ss = { slow: 600, fast: 200 }; - o.duration = (s && s.constructor == Number ? s : ss[s]) || 400; - - // Queueing - o.oldComplete = o.complete; - o.complete = function(){ - jQuery.dequeue(this, "fx"); - if ( o.oldComplete && o.oldComplete.constructor == Function ) - o.oldComplete.apply( this ); - }; - - return o; - }, - - queue: {}, - - dequeue: function(elem,type){ - type = type || "fx"; - - if ( elem.queue && elem.queue[type] ) { - // Remove self - elem.queue[type].shift(); - - // Get next function - var f = elem.queue[type][0]; - - if ( f ) f.apply( elem ); - } - }, - - /* - * 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 - * people. You've been warned. - */ - - fx: function( elem, options, prop ){ - - var z = this; - - // The users options - z.o = { - duration: options.duration || 400, - complete: options.complete, - step: options.step - }; - - // The element - z.el = elem; - - // The styles - var y = z.el.style; - - // Simple function for setting a style value - 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) ) - y[prop] = parseInt(z.now) + "px"; - - y.display = "block"; - }; - - // Figure out the maximum number to run to - z.max = function(){ - return parseFloat( jQuery.css(z.el,prop) ); - }; - - // Get the current size - z.cur = function(){ - var r = parseFloat( jQuery.curCSS(z.el, prop) ); - return r && r > -10000 ? r : z.max(); - }; - - // Start an animation from one number to another - z.custom = function(from,to){ - z.startTime = (new Date()).getTime(); - z.now = from; - z.a(); - - z.timer = setInterval(function(){ - z.step(from, to); - }, 13); - }; - - // Simple 'show' function - z.show = function( p ){ - if ( !z.el.orig ) z.el.orig = {}; - - // 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] ); - - // Stupid IE, look what you made me do - if ( prop != "opacity" ) - y[prop] = "1px"; - }; - - // Simple 'hide' function - z.hide = function(){ - if ( !z.el.orig ) z.el.orig = {}; - - // Remember where we started, so that we can go back to it later - z.el.orig[prop] = this.cur(); - - z.o.hide = true; - - // Begin the animation - 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" ); - - // Make sure that nothing sneaks out - y.overflow = "hidden"; - - // Each step of an animation - z.step = function(firstNum, lastNum){ - var t = (new Date()).getTime(); - - if (t > z.o.duration + z.startTime) { - // Stop the timer - clearInterval(z.timer); - z.timer = null; - - z.now = lastNum; - z.a(); - - z.el.curAnim[ prop ] = true; - - var done = true; - for ( var i in z.el.curAnim ) - if ( z.el.curAnim[i] !== true ) - done = false; - - if ( done ) { - // Reset the overflow - y.overflow = z.el.oldOverflow; - - // Hide the element if the "hide" operation was done - if ( z.o.hide ) - y.display = 'none'; - - // 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" ); - - // set its height and/or width to auto - if ( p == 'height' || p == 'width' ) - jQuery.setAuto( z.el, p ); - } - } - } - - // If a callback was provided, execute it - if( done && z.o.complete && z.o.complete.constructor == Function ) - // Execute the complete function - z.o.complete.apply( z.el ); - } else { - // Figure out where in the animation we are and set the number - var p = (t - this.startTime) / z.o.duration; - z.now = ((-Math.cos(p*Math.PI)/2) + 0.5) * (lastNum-firstNum) + firstNum; - - // Perform the next step of the animation - z.a(); - } - }; - - } - -}); +jQuery.fn.extend({ + + /** + * Displays each of the set of matched elements if they are hidden. + * + * @example $("p").show() + * @before
+ * @result [Hello
] + * + * @name show + * @type jQuery + * @cat Effects + */ + + /** + * Show all matched elements using a graceful animation and firing an + * optional callback after completion. + * + * The height, width, and opacity of each of the matched elements + * are changed dynamically according to the specified speed. + * + * @example $("p").show("slow"); + * + * @example $("p").show("slow",function(){ + * alert("Animation Done."); + * }); + * + * @name show + * @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 Function callback (optional) A function to be executed whenever the animation completes. + * @cat Effects + * @see hide(String|Number,Function) + */ + show: function(speed,callback){ + return speed ? + this.animate({ + height: "show", width: "show", opacity: "show" + }, speed, callback) : + + this.filter(":hidden").each(function(){ + this.style.display = this.oldblock ? this.oldblock : ""; + if ( jQuery.css(this,"display") == "none" ) + this.style.display = "block"; + }).end(); + }, + + /** + * Hides each of the set of matched elements if they are shown. + * + * @example $("p").hide() + * @beforeHello
+ * @result [ ] + * + * @name hide + * @type jQuery + * @cat Effects + */ + + /** + * Hide all matched elements using a graceful animation and firing an + * optional callback after completion. + * + * The height, width, and opacity of each of the matched elements + * are changed dynamically according to the specified speed. + * + * @example $("p").hide("slow"); + * + * @example $("p").hide("slow",function(){ + * alert("Animation Done."); + * }); + * + * @name hide + * @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 Function callback (optional) A function to be executed whenever the animation completes. + * @cat Effects + * @see show(String|Number,Function) + */ + hide: function(speed,callback){ + return speed ? + this.animate({ + height: "hide", width: "hide", opacity: "hide" + }, speed, callback) : + + this.filter(":visible").each(function(){ + this.oldblock = this.oldblock || jQuery.css(this,"display"); + if ( this.oldblock == "none" ) + this.oldblock = "block"; + this.style.display = "none"; + }).end(); + }, + + // Save the old toggle function + _toggle: jQuery.fn.toggle, + + /** + * Toggles each of the set of matched elements. If they are shown, + * toggle makes them hidden. If they are hidden, toggle + * makes them shown. + * + * @example $("p").toggle() + * @beforeHello
+ * @result [ ,Hello Again
] + * + * @name toggle + * @type jQuery + * @cat Effects + */ + toggle: function( fn, fn2 ){ + return jQuery.isFunction(fn) && jQuery.isFunction(fn2) ? + this._toggle( fn, fn2 ) : + fn ? + this.animate({ + height: "toggle", width: "toggle", opacity: "toggle" + }, fn, fn2) : + this.each(function(){ + jQuery(this)[ jQuery(this).is(":hidden") ? "show" : "hide" ](); + }); + }, + + /** + * Reveal all matched elements by adjusting their height and firing an + * optional callback after completion. + * + * Only the height is adjusted for this animation, causing all matched + * elements to be revealed in a "sliding" manner. + * + * @example $("p").slideDown("slow"); + * + * @example $("p").slideDown("slow",function(){ + * alert("Animation Done."); + * }); + * + * @name slideDown + * @type jQuery + * @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 + * @see slideUp(String|Number,Function) + * @see slideToggle(String|Number,Function) + */ + slideDown: function(speed,callback){ + return this.animate({height: "show"}, speed, callback); + }, + + /** + * Hide all matched elements by adjusting their height and firing an + * optional callback after completion. + * + * Only the height is adjusted for this animation, causing all matched + * elements to be hidden in a "sliding" manner. + * + * @example $("p").slideUp("slow"); + * + * @example $("p").slideUp("slow",function(){ + * alert("Animation Done."); + * }); + * + * @name slideUp + * @type jQuery + * @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 + * @see slideDown(String|Number,Function) + * @see slideToggle(String|Number,Function) + */ + slideUp: function(speed,callback){ + return this.animate({height: "hide"}, speed, callback); + }, + + /** + * Toggle the visibility of all matched elements by adjusting their height and firing an + * optional callback 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"); + * + * @example $("p").slideToggle("slow",function(){ + * alert("Animation Done."); + * }); + * + * @name slideToggle + * @type jQuery + * @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 + * @see slideDown(String|Number,Function) + * @see slideUp(String|Number,Function) + */ + slideToggle: function(speed, callback){ + return this.animate({height: "toggle"}, speed, callback); + }, + + /** + * Fade in all matched elements by adjusting their opacity and firing an + * optional callback after completion. + * + * Only the opacity is adjusted for this animation, meaning that + * all of the matched elements should already have some form of height + * and width associated with them. + * + * @example $("p").fadeIn("slow"); + * + * @example $("p").fadeIn("slow",function(){ + * alert("Animation Done."); + * }); + * + * @name fadeIn + * @type jQuery + * @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 + * @see fadeOut(String|Number,Function) + * @see fadeTo(String|Number,Number,Function) + */ + fadeIn: function(speed, callback){ + return this.animate({opacity: "show"}, speed, callback); + }, + + /** + * Fade out all matched elements by adjusting their opacity and firing an + * optional callback after completion. + * + * Only the opacity is adjusted for this animation, meaning that + * all of the matched elements should already have some form of height + * and width associated with them. + * + * @example $("p").fadeOut("slow"); + * + * @example $("p").fadeOut("slow",function(){ + * alert("Animation Done."); + * }); + * + * @name fadeOut + * @type jQuery + * @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 + * @see fadeIn(String|Number,Function) + * @see fadeTo(String|Number,Number,Function) + */ + fadeOut: function(speed, callback){ + return this.animate({opacity: "hide"}, speed, callback); + }, + + /** + * Fade the opacity of all matched elements to a specified opacity and firing an + * optional callback after completion. + * + * Only the opacity is adjusted for this animation, meaning that + * all of the matched elements should already have some form of height + * and width associated with them. + * + * @example $("p").fadeTo("slow", 0.5); + * + * @example $("p").fadeTo("slow", 0.5, function(){ + * alert("Animation Done."); + * }); + * + * @name fadeTo + * @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 Number opacity The opacity to fade to (a number from 0 to 1). + * @param Function callback (optional) A function to be executed whenever the animation completes. + * @cat Effects + * @see fadeIn(String|Number,Function) + * @see fadeOut(String|Number,Function) + */ + fadeTo: function(speed,to,callback){ + return this.animate({opacity: to}, speed, callback); + }, + + /** + * 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. + * Otherwise 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); + * + * @example $("p").animate({ + * opacity: 'show' + * }, "slow", "easein"); + * @desc An example of using an 'easing' function to provide a different style of animation. This will only work if you have a plugin that provides this easing function (Only "swing" and "linear" are provided by default, with jQuery). + * + * @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 (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 (e.g. "swing" or "linear"). Defaults to "swing". + * @param Function callback (optional) A function to be executed whenever the animation completes. + * @cat Effects + */ + animate: function( prop, speed, easing, callback ) { + return this.queue(function(){ + var hidden = jQuery(this).is(":hidden"), + opt = jQuery.speed(speed, easing, callback), + self = this; + + for ( var p in prop ) { + if ( prop[p] == "hide" && hidden || prop[p] == "show" && !hidden ) + return jQuery.isFunction(opt.complete) && opt.complete.apply(this); + + if ( p == "height" || p == "width" ) { + // Store display property + opt.display = jQuery.css(this, "display"); + + // Make sure that nothing sneaks out + opt.overflow = this.style.overflow; + } + } + + if ( opt.overflow != null ) + this.style.overflow = "hidden"; + + this.curAnim = jQuery.extend({}, prop); + + jQuery.each( prop, function(name, val){ + var e = new jQuery.fx( self, opt, name ); + if ( val.constructor == Number ) + e.custom( e.cur(), val ); + else + e[ val == "toggle" ? hidden ? "show" : "hide" : val ]( prop ); + }); + }); + }, + + /** + * + * @private + */ + queue: function(type,fn){ + if ( !fn ) { + fn = type; + type = "fx"; + } + + return this.each(function(){ + if ( !this.queue ) + this.queue = {}; + + if ( !this.queue[type] ) + this.queue[type] = []; + + this.queue[type].push( fn ); + + if ( this.queue[type].length == 1 ) + fn.apply(this); + }); + } + +}); + +jQuery.extend({ + + speed: function(speed, easing, fn) { + var opt = speed && speed.constructor == Object ? speed : { + complete: fn || !fn && easing || + jQuery.isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && easing.constructor != Function && easing || (jQuery.easing.swing ? "swing" : "linear") + }; + + opt.duration = (opt.duration && opt.duration.constructor == Number ? + opt.duration : + { slow: 600, fast: 200 }[opt.duration]) || 400; + + // Queueing + opt.old = opt.complete; + opt.complete = function(){ + jQuery.dequeue(this, "fx"); + if ( jQuery.isFunction( opt.old ) ) + opt.old.apply( this ); + }; + + return opt; + }, + + 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: {}, + + dequeue: function(elem,type){ + type = type || "fx"; + + if ( elem.queue && elem.queue[type] ) { + // Remove self + elem.queue[type].shift(); + + // Get next function + var f = elem.queue[type][0]; + + if ( f ) f.apply( elem ); + } + }, + + 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 + * people. You've been warned. + */ + + fx: function( elem, options, prop ){ + + var z = this; + + // The styles + var y = elem.style; + + // Simple function for setting a style value + z.a = function(){ + if ( options.step ) + options.step.apply( elem, [ z.now ] ); + + if ( prop == "opacity" ) + jQuery.attr(y, "opacity", z.now); // Let attr handle opacity + 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 + z.max = function(){ + return parseFloat( jQuery.css(elem,prop) ); + }; + + // Get the current size + z.cur = function(){ + var r = parseFloat( jQuery.curCSS(elem, prop) ); + return r && r > -10000 ? r : z.max(); + }; + + // Start an animation from one number to another + z.custom = function(from,to){ + z.startTime = (new Date()).getTime(); + z.now = from; + z.a(); + + jQuery.timers.push(function(){ + return z.step(from, to); + }); + + if ( jQuery.timers.length == 1 ) { + var timer = setInterval(function(){ + var timers = jQuery.timers; + + for ( var i = 0; i < timers.length; i++ ) + if ( !timers[i]() ) + timers.splice(i--, 1); + + if ( !timers.length ) + clearInterval( timer ); + }, 13); + } + }; + + // Simple 'show' function + z.show = function(){ + if ( !elem.orig ) elem.orig = {}; + + // Remember where we started, so that we can go back to it later + elem.orig[prop] = jQuery.attr( elem.style, prop ); + + options.show = true; + + // Begin the animation + z.custom(0, this.cur()); + + // Make sure that we start at a small width/height to avoid any + // flash of content + if ( prop != "opacity" ) + y[prop] = "1px"; + + // Start by showing the element + jQuery(elem).show(); + }; + + // Simple 'hide' function + z.hide = function(){ + if ( !elem.orig ) elem.orig = {}; + + // Remember where we started, so that we can go back to it later + elem.orig[prop] = jQuery.attr( elem.style, prop ); + + options.hide = true; + + // Begin the animation + z.custom(this.cur(), 0); + }; + + // Each step of an animation + z.step = function(firstNum, lastNum){ + var t = (new Date()).getTime(); + + if (t > options.duration + z.startTime) { + z.now = lastNum; + z.a(); + + if (elem.curAnim) elem.curAnim[ prop ] = true; + + var done = true; + for ( var i in elem.curAnim ) + if ( elem.curAnim[i] !== true ) + done = false; + + if ( done ) { + if ( options.display != null ) { + // Reset the overflow + y.overflow = options.overflow; + + // Reset the display + y.display = options.display; + if ( jQuery.css(elem, "display") == "none" ) + y.display = "block"; + } + + // Hide the element if the "hide" operation was done + if ( options.hide ) + 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 ) + jQuery.attr(y, p, elem.orig[p]); + } + + // If a callback was provided, execute it + 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; + + // 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; + }; + + } +});