* The effects module overloads the show method to now allow
* Show all matched elements using a graceful animation.
* for a speed to the show operation. What actually happens is
* The height, width, and opacity of each of the matched elements
* that the height, width, and opacity to the matched elements
* are changed dynamically according to the specified speed.
* are changed dynamically. The only three current speeds are
*
* "slow", "normal", and "fast". For example:
* @example $("p").show("slow");
* $("p").show("slow");
*
* Note: You should not run the show method on things
* @name show
* that are already shown. This can be circumvented by doing this:
* @type jQuery
* $("p:hidden").show("slow");
* @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).
*/
/**
* 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.
*/
*/
show:function(speed,callback){
show:function(speed,callback){
returnspeed?this.animate({
returnspeed?this.animate({
...
@@ -24,9 +40,31 @@ jQuery.fn.extend({
...
@@ -24,9 +40,31 @@ jQuery.fn.extend({
_hide:jQuery.fn.hide,
_hide:jQuery.fn.hide,
/**
/**
* The hide function behaves very similary to the show function,
* Hide all matched elements using a graceful animation.
* but is just the opposite.
* The height, width, and opacity of each of the matched elements
* $("p:visible").hide("slow");
* 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).
*/
/**
* 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.
*/
*/
hide:function(speed,callback){
hide:function(speed,callback){
returnspeed?this.animate({
returnspeed?this.animate({
...
@@ -35,49 +73,170 @@ jQuery.fn.extend({
...
@@ -35,49 +73,170 @@ jQuery.fn.extend({
},
},
/**
/**
* This function increases the height and opacity for all matched
* Reveal all matched elements by adjusting their height.
* elements. This is very similar to 'show', but does not change
* Only the height is adjusted for this animation, causing all matched
* the width - creating a neat sliding effect.
* elements to be revealed in a "sliding" manner.
* $("p:hidden").slideDown("slow");
*
* @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).
*/
/**
* 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.
* Just like slideDown, only it hides all matched elements.
* Hide all matched elements by adjusting their height.
* $("p:visible").slideUp("slow");
* 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).
*/
/**
* 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.
* Adjusts the opacity of all matched elements from a hidden,
* Fade in all matched elements by adjusting their opacity.
* to a fully visible, state.
* Only the opacity is adjusted for this animation, meaning that
* $("p:hidden").fadeIn("slow");
* 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).
*/
/**
* 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.
* Same as fadeIn, but transitions from a visible, to a hidden state.
* Fade out all matched elements by adjusting their opacity.
* $("p:visible").fadeOut("slow");
* 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).
*/
/**
* 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.
* 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).
*/
/**
* 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.