Skip to content

Commit c06c6b6

Browse files
kswedbergkswedberg
committed
Add jQuery.Animation and jQuery.Tween. Work in Progress
1 parent 4bbedac commit c06c6b6

2 files changed

Lines changed: 66 additions & 0 deletions

File tree

‎entries/jQuery.Animation.xml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<?xml version="1.0"?>
2+
<entry name="jQuery.Animation" type="method" return="Promise">
3+
<title>jQuery.Animation()</title>
4+
<signature>
5+
<added>1.8</added>
6+
<argument name="progressCallbacks" type="Function">
7+
<desc>
8+
A function, or array of functions, that is called when the Deferred generates progress notifications.
9+
</desc>
10+
</argument>
11+
</signature>
12+
<desc> </desc>
13+
<longdesc>
14+
<p>
15+
The <code>jQuery.Tween</code> function is called internally by <code>.animate()</code>. It is provided mostly for plugin authors to further customize animations.
16+
</p>
17+
<p>The <code>jQuery.Tween</code> function returns a Tween object with the following properties:</p>
18+
<ul>
19+
<li><strong>elem</strong>: The animated DOM element</li>
20+
<li><strong>prop</strong>: The property being animated</li>
21+
<li><strong>easing</strong>: A string representing the easing being used</li>
22+
<li><strong>start</strong>: A number representing the starting value of the tween</li>
23+
<li><strong>now</strong>: A number representing the current value of the tween</li>
24+
<li><strong>end</strong>: A number representing the ending value of the tween</li>
25+
<li><strong>unit</strong>: A string representing the CSS unit for the tween</li>
26+
<li><strong>options</strong>: A reference to the animation options object</li>
27+
<li><strong>cur()</strong>: A function that reads the current value of the animated property from the element</li>
28+
</ul>
29+
30+
</longdesc>
31+
<category slug="effects/custom-effects"/>
32+
<category slug="version/1.8"/>
33+
</entry>

‎entries/jQuery.Tween.xml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<?xml version="1.0"?>
2+
<entry name="jQuery.Tween" type="method" return="Tween">
3+
<title>jQuery.Tween()</title>
4+
<signature>
5+
<added>1.8</added>
6+
<argument name="progressCallbacks" type="Function">
7+
<desc>
8+
A function, or array of functions, that is called when the Deferred generates progress notifications.
9+
</desc>
10+
</argument>
11+
</signature>
12+
<desc> </desc>
13+
<longdesc>
14+
<p>
15+
The <code>jQuery.Tween</code> function is called internally by <code>.animate()</code>. It is provided mostly for plugin authors to further customize animations.
16+
</p>
17+
<p>The <code>jQuery.Tween</code> function returns a Tween object with the following properties:</p>
18+
<ul>
19+
<li><strong>elem</strong>: The animated DOM element</li>
20+
<li><strong>prop</strong>: The property being animated</li>
21+
<li><strong>easing</strong>: A string representing the easing being used</li>
22+
<li><strong>start</strong>: A number representing the starting value of the tween</li>
23+
<li><strong>now</strong>: A number representing the current value of the tween</li>
24+
<li><strong>end</strong>: A number representing the ending value of the tween</li>
25+
<li><strong>unit</strong>: A string representing the CSS unit for the tween</li>
26+
<li><strong>options</strong>: A reference to the animation options object</li>
27+
<li><strong>cur()</strong>: A function that reads the current value of the animated property from the element</li>
28+
</ul>
29+
30+
</longdesc>
31+
<category slug="effects/custom-effects"/>
32+
<category slug="version/1.8"/>
33+
</entry>

0 commit comments

Comments
 (0)