3fd4990208b17df7fed6a12732b8353453fd28d1
[jquery.git] / src / fx / fx.js
1 jQuery.fn.extend({
2
3         // overwrite the old show method
4         _show: jQuery.fn.show,
5         
6         /**
7          * Show all matched elements using a graceful animation.
8          * The height, width, and opacity of each of the matched elements 
9          * are changed dynamically according to the specified speed.
10          *
11          * @example $("p").show("slow");
12          *
13          * @name show
14          * @type jQuery
15          * @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).
16          * @cat Effects/Animations
17          */
18          
19         /**
20          * Show all matched elements using a graceful animation and firing a callback
21          * function after completion.
22          * The height, width, and opacity of each of the matched elements 
23          * are changed dynamically according to the specified speed.
24          *
25          * @example $("p").show("slow",function(){
26          *   alert("Animation Done.");
27          * });
28          *
29          * @name show
30          * @type jQuery
31          * @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).
32          * @param Function callback A function to be executed whenever the animation completes.
33          * @cat Effects/Animations
34          */
35         show: function(speed,callback){
36                 return speed ? this.animate({
37                         height: "show", width: "show", opacity: "show"
38                 }, speed, callback) : this._show();
39         },
40         
41         // Overwrite the old hide method
42         _hide: jQuery.fn.hide,
43         
44         /**
45          * Hide all matched elements using a graceful animation.
46          * The height, width, and opacity of each of the matched elements 
47          * are changed dynamically according to the specified speed.
48          *
49          * @example $("p").hide("slow");
50          *
51          * @name hide
52          * @type jQuery
53          * @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).
54          * @cat Effects/Animations
55          */
56          
57         /**
58          * Hide all matched elements using a graceful animation and firing a callback
59          * function after completion.
60          * The height, width, and opacity of each of the matched elements 
61          * are changed dynamically according to the specified speed.
62          *
63          * @example $("p").hide("slow",function(){
64          *   alert("Animation Done.");
65          * });
66          *
67          * @name hide
68          * @type jQuery
69          * @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).
70          * @param Function callback A function to be executed whenever the animation completes.
71          * @cat Effects/Animations
72          */
73         hide: function(speed,callback){
74                 return speed ? this.animate({
75                         height: "hide", width: "hide", opacity: "hide"
76                 }, speed, callback) : this._hide();
77         },
78         
79         /**
80          * Reveal all matched elements by adjusting their height.
81          * Only the height is adjusted for this animation, causing all matched
82          * elements to be revealed in a "sliding" manner.
83          *
84          * @example $("p").slideDown("slow");
85          *
86          * @name slideDown
87          * @type jQuery
88          * @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).
89          * @cat Effects/Animations
90          */
91          
92         /**
93          * Reveal all matched elements by adjusting their height and firing a callback
94          * function after completion.
95          * Only the height is adjusted for this animation, causing all matched
96          * elements to be revealed in a "sliding" manner.
97          *
98          * @example $("p").slideDown("slow",function(){
99          *   alert("Animation Done.");
100          * });
101          *
102          * @name slideDown
103          * @type jQuery
104          * @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).
105          * @param Function callback A function to be executed whenever the animation completes.
106          * @cat Effects/Animations
107          */
108         slideDown: function(speed,callback){
109                 return this.animate({height: "show"}, speed, callback);
110         },
111         
112         /**
113          * Hide all matched elements by adjusting their height.
114          * Only the height is adjusted for this animation, causing all matched
115          * elements to be hidden in a "sliding" manner.
116          *
117          * @example $("p").slideUp("slow");
118          *
119          * @name slideUp
120          * @type jQuery
121          * @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).
122          * @cat Effects/Animations
123          */
124          
125         /**
126          * Hide all matched elements by adjusting their height and firing a callback
127          * function after completion.
128          * Only the height is adjusted for this animation, causing all matched
129          * elements to be hidden in a "sliding" manner.
130          *
131          * @example $("p").slideUp("slow",function(){
132          *   alert("Animation Done.");
133          * });
134          *
135          * @name slideUp
136          * @type jQuery
137          * @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).
138          * @param Function callback A function to be executed whenever the animation completes.
139          * @cat Effects/Animations
140          */
141         slideUp: function(speed,callback){
142                 return this.animate({height: "hide"}, speed, callback);
143         },
144
145         /**
146          * Toggle the visibility of all matched elements by adjusting their height.
147          * Only the height is adjusted for this animation, causing all matched
148          * elements to be hidden in a "sliding" manner.
149          *
150          * @example $("p").slideToggle("slow");
151          *
152          * @name slideToggle
153          * @type jQuery
154          * @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).
155          * @cat Effects/Animations
156          */
157          
158         /**
159          * Toggle the visibility of all matched elements by adjusting their height
160          * and firing a callback function after completion.
161          * Only the height is adjusted for this animation, causing all matched
162          * elements to be hidden in a "sliding" manner.
163          *
164          * @example $("p").slideToggle("slow",function(){
165          *   alert("Animation Done.");
166          * });
167          *
168          * @name slideToggle
169          * @type jQuery
170          * @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).
171          * @param Function callback A function to be executed whenever the animation completes.
172          * @cat Effects/Animations
173          */
174         slideToggle: function(speed,callback){
175                 return this.each(function(){
176                         var state = jQuery(this).is(":hidden") ? "show" : "hide";
177                         jQuery(this).animate({height: state}, speed, callback);
178                 });
179         },
180         
181         /**
182          * Fade in all matched elements by adjusting their opacity.
183          * Only the opacity is adjusted for this animation, meaning that
184          * all of the matched elements should already have some form of height
185          * and width associated with them.
186          *
187          * @example $("p").fadeIn("slow");
188          *
189          * @name fadeIn
190          * @type jQuery
191          * @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).
192          * @cat Effects/Animations
193          */
194          
195         /**
196          * Fade in all matched elements by adjusting their opacity and firing a 
197          * callback function after completion.
198          * Only the opacity is adjusted for this animation, meaning that
199          * all of the matched elements should already have some form of height
200          * and width associated with them.
201          *
202          * @example $("p").fadeIn("slow",function(){
203          *   alert("Animation Done.");
204          * });
205          *
206          * @name fadeIn
207          * @type jQuery
208          * @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).
209          * @param Function callback A function to be executed whenever the animation completes.
210          * @cat Effects/Animations
211          */
212         fadeIn: function(speed,callback){
213                 return this.animate({opacity: "show"}, speed, callback);
214         },
215         
216         /**
217          * Fade out all matched elements by adjusting their opacity.
218          * Only the opacity is adjusted for this animation, meaning that
219          * all of the matched elements should already have some form of height
220          * and width associated with them.
221          *
222          * @example $("p").fadeOut("slow");
223          *
224          * @name fadeOut
225          * @type jQuery
226          * @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).
227          * @cat Effects/Animations
228          */
229          
230         /**
231          * Fade out all matched elements by adjusting their opacity and firing a 
232          * callback function after completion.
233          * Only the opacity is adjusted for this animation, meaning that
234          * all of the matched elements should already have some form of height
235          * and width associated with them.
236          *
237          * @example $("p").fadeOut("slow",function(){
238          *   alert("Animation Done.");
239          * });
240          *
241          * @name fadeOut
242          * @type jQuery
243          * @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).
244          * @param Function callback A function to be executed whenever the animation completes.
245          * @cat Effects/Animations
246          */
247         fadeOut: function(speed,callback){
248                 return this.animate({opacity: "hide"}, speed, callback);
249         },
250         
251         /**
252          * Fade the opacity of all matched elements to a specified opacity.
253          * Only the opacity is adjusted for this animation, meaning that
254          * all of the matched elements should already have some form of height
255          * and width associated with them.
256          *
257          * @example $("p").fadeTo("slow", 0.5);
258          *
259          * @name fadeTo
260          * @type jQuery
261          * @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).
262          * @param Number opacity The opacity to fade to (a number from 0 to 1).
263          * @cat Effects/Animations
264          */
265          
266         /**
267          * Fade the opacity of all matched elements to a specified opacity and 
268          * firing a callback function after completion.
269          * Only the opacity is adjusted for this animation, meaning that
270          * all of the matched elements should already have some form of height
271          * and width associated with them.
272          *
273          * @example $("p").fadeTo("slow", 0.5, function(){
274          *   alert("Animation Done.");
275          * });
276          *
277          * @name fadeTo
278          * @type jQuery
279          * @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).
280          * @param Number opacity The opacity to fade to (a number from 0 to 1).
281          * @param Function callback A function to be executed whenever the animation completes.
282          * @cat Effects/Animations
283          */
284         fadeTo: function(speed,to,callback){
285                 return this.animate({opacity: to}, speed, callback);
286         },
287         
288         /**
289          * A function for making your own, custom, animations. The key aspect of
290          * this function is the object of style properties that will be animated,
291          * and to what end. Each key within the object represents a style property
292          * that will also be animated (for example: "height", "top", or "opacity").
293          *
294          * The value associated with the key represents to what end the property
295          * will be animated. If a number is provided as the value, then the style
296          * property will be transitioned from its current state to that new number.
297          * Oterwise if the string "hide", "show", or "toggle" is provided, a default
298          * animation will be constructed for that property.
299          *
300          * @example $("p").animate({
301          *   height: 'toggle', opacity: 'toggle'
302          * }, "slow");
303          *
304          * @example $("p").animate({
305          *   left: 50, opacity: 'show'
306          * }, 500);
307          *
308          * @test stop();
309          * var hash = {opacity: 'show'};
310          * var hashCopy = $.extend({}, hash);
311          * $('#foo').animate(hash, 'fast', function() {
312          *  ok( hash.opacity == hashCopy.opacity, 'Check if animate changed the hash parameter' );
313          *  start();
314          * });
315          *
316          * @name animate
317          * @type jQuery
318          * @param Hash params A set of style attributes that you wish to animate, and to what end.
319          * @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).
320          * @param Function callback A function to be executed whenever the animation completes.
321          * @cat Effects/Animations
322          */
323         animate: function(prop,speed,callback) {
324                 return this.queue(function(){
325                 
326                         this.curAnim = jQuery.extend({}, prop);
327                         
328                         for ( var p in prop ) {
329                                 var e = new jQuery.fx( this, jQuery.speed(speed,callback), p );
330                                 if ( prop[p].constructor == Number )
331                                         e.custom( e.cur(), prop[p] );
332                                 else
333                                         e[ prop[p] ]( prop );
334                         }
335                         
336                 });
337         },
338         
339         /**
340          *
341          * @private
342          */
343         queue: function(type,fn){
344                 if ( !fn ) {
345                         fn = type;
346                         type = "fx";
347                 }
348         
349                 return this.each(function(){
350                         if ( !this.queue )
351                                 this.queue = {};
352         
353                         if ( !this.queue[type] )
354                                 this.queue[type] = [];
355         
356                         this.queue[type].push( fn );
357                 
358                         if ( this.queue[type].length == 1 )
359                                 fn.apply(this);
360                 });
361         }
362
363 });
364
365 jQuery.extend({
366
367         setAuto: function(e,p) {
368                 if ( e.notAuto ) return;
369
370                 if ( p == "height" && e.scrollHeight != parseInt(jQuery.curCSS(e,p)) ) return;
371                 if ( p == "width" && e.scrollWidth != parseInt(jQuery.curCSS(e,p)) ) return;
372
373                 // Remember the original height
374                 var a = e.style[p];
375
376                 // Figure out the size of the height right now
377                 var o = jQuery.curCSS(e,p,1);
378
379                 if ( p == "height" && e.scrollHeight != o ||
380                         p == "width" && e.scrollWidth != o ) return;
381
382                 // Set the height to auto
383                 e.style[p] = e.currentStyle ? "" : "auto";
384
385                 // See what the size of "auto" is
386                 var n = jQuery.curCSS(e,p,1);
387
388                 // Revert back to the original size
389                 if ( o != n && n != "auto" ) {
390                         e.style[p] = a;
391                         e.notAuto = true;
392                 }
393         },
394         
395         speed: function(s,o) {
396                 o = o || {};
397                 
398                 if ( o.constructor == Function )
399                         o = { complete: o };
400                 
401                 var ss = { slow: 600, fast: 200 };
402                 o.duration = (s && s.constructor == Number ? s : ss[s]) || 400;
403         
404                 // Queueing
405                 o.oldComplete = o.complete;
406                 o.complete = function(){
407                         jQuery.dequeue(this, "fx");
408                         if ( o.oldComplete && o.oldComplete.constructor == Function )
409                                 o.oldComplete.apply( this );
410                 };
411         
412                 return o;
413         },
414         
415         queue: {},
416         
417         dequeue: function(elem,type){
418                 type = type || "fx";
419         
420                 if ( elem.queue && elem.queue[type] ) {
421                         // Remove self
422                         elem.queue[type].shift();
423         
424                         // Get next function
425                         var f = elem.queue[type][0];
426                 
427                         if ( f ) f.apply( elem );
428                 }
429         },
430
431         /*
432          * I originally wrote fx() as a clone of moo.fx and in the process
433          * of making it small in size the code became illegible to sane
434          * people. You've been warned.
435          */
436         
437         fx: function( elem, options, prop ){
438         
439                 var z = this;
440         
441                 // The users options
442                 z.o = {
443                         duration: options.duration || 400,
444                         complete: options.complete,
445                         step: options.step
446                 };
447         
448                 // The element
449                 z.el = elem;
450         
451                 // The styles
452                 var y = z.el.style;
453         
454                 // Simple function for setting a style value
455                 z.a = function(){
456                         if ( options.step )
457                                 options.step.apply( elem, [ z.now ] );
458  
459                         if ( prop == "opacity" )
460                                 jQuery.attr(y, "opacity", z.now); // Let attr handle opacity
461                         else if ( parseInt(z.now) ) // My hate for IE will never die
462                                 y[prop] = parseInt(z.now) + "px";
463                                 
464                         y.display = "block";
465                 };
466         
467                 // Figure out the maximum number to run to
468                 z.max = function(){
469                         return parseFloat( jQuery.css(z.el,prop) );
470                 };
471         
472                 // Get the current size
473                 z.cur = function(){
474                         var r = parseFloat( jQuery.curCSS(z.el, prop) );
475                         return r && r > -10000 ? r : z.max();
476                 };
477         
478                 // Start an animation from one number to another
479                 z.custom = function(from,to){
480                         z.startTime = (new Date()).getTime();
481                         z.now = from;
482                         z.a();
483         
484                         z.timer = setInterval(function(){
485                                 z.step(from, to);
486                         }, 13);
487                 };
488         
489                 // Simple 'show' function
490                 z.show = function(){
491                         if ( !z.el.orig ) z.el.orig = {};
492
493                         // Remember where we started, so that we can go back to it later
494                         z.el.orig[prop] = this.cur();
495                         
496                         // Begin the animation
497                         z.custom(0, z.el.orig[prop]);
498
499                         // Stupid IE, look what you made me do
500                         if ( prop != "opacity" )
501                                 y[prop] = "1px";
502                 };
503         
504                 // Simple 'hide' function
505                 z.hide = function(){
506                         if ( !z.el.orig ) z.el.orig = {};
507
508                         // Remember where we started, so that we can go back to it later
509                         z.el.orig[prop] = this.cur();
510
511                         z.o.hide = true;
512
513                         // Begin the animation
514                         z.custom(z.el.orig[prop], 0);
515                 };
516         
517                 // Remember  the overflow of the element
518                 if ( !z.el.oldOverflow )
519                         z.el.oldOverflow = jQuery.css( z.el, "overflow" );
520         
521                 // Make sure that nothing sneaks out
522                 y.overflow = "hidden";
523         
524                 // Each step of an animation
525                 z.step = function(firstNum, lastNum){
526                         var t = (new Date()).getTime();
527         
528                         if (t > z.o.duration + z.startTime) {
529                                 // Stop the timer
530                                 clearInterval(z.timer);
531                                 z.timer = null;
532
533                                 z.now = lastNum;
534                                 z.a();
535
536                                 z.el.curAnim[ prop ] = true;
537                                 
538                                 var done = true;
539                                 for ( var i in z.el.curAnim )
540                                         if ( z.el.curAnim[i] !== true )
541                                                 done = false;
542                                                 
543                                 if ( done ) {
544                                         // Reset the overflow
545                                         y.overflow = z.el.oldOverflow;
546                                 
547                                         // Hide the element if the "hide" operation was done
548                                         if ( z.o.hide ) 
549                                                 y.display = 'none';
550                                         
551                                         // Reset the property, if the item has been hidden
552                                         if ( z.o.hide ) {
553                                                 for ( var p in z.el.curAnim ) {
554                                                         if (p == "opacity")
555                                                                 jQuery.attr(y, p, z.el.orig[p]);
556                                                         else
557                                                                 y[ p ] = z.el.orig[p] + "px";
558         
559                                                         // set its height and/or width to auto
560                                                         if ( p == 'height' || p == 'width' )
561                                                                 jQuery.setAuto( z.el, p );
562                                                 }
563                                         }
564                                 }
565
566                                 // If a callback was provided, execute it
567                                 if( done && z.o.complete && z.o.complete.constructor == Function )
568                                         // Execute the complete function
569                                         z.o.complete.apply( z.el );
570                         } else {
571                                 // Figure out where in the animation we are and set the number
572                                 var p = (t - this.startTime) / z.o.duration;
573                                 z.now = ((-Math.cos(p*Math.PI)/2) + 0.5) * (lastNum-firstNum) + firstNum;
574         
575                                 // Perform the next step of the animation
576                                 z.a();
577                         }
578                 };
579         
580         }
581
582 });