Commit d7fe34c4 authored by Ed Engelhardt's avatar Ed Engelhardt

improve documentation of animate() function by mentioning both the 'swing' and...

improve documentation of animate() function by mentioning both the 'swing' and 'linear' easings which are provided by default
parent 19f5cf0c
...@@ -295,13 +295,13 @@ jQuery.fn.extend({ ...@@ -295,13 +295,13 @@ jQuery.fn.extend({
* @example $("p").animate({ * @example $("p").animate({
* opacity: 'show' * opacity: 'show'
* }, "slow", "easein"); * }, "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 'linear' is provided by default, with jQuery). * @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 * @name animate
* @type jQuery * @type jQuery
* @param Hash params A set of style attributes that you wish to animate, and to what end. * @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|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 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. * @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects * @cat Effects
*/ */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment