Skip to content

Animate 1.8 #1111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Animate 1.8 #1111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
de03e27
Add jQuery 1.8 animation option properties
kswedberg Oct 8, 2012
4bbedac
Clean up options argument include
kswedberg Oct 15, 2012
c06c6b6
Add jQuery.Animation and jQuery.Tween. Work in Progress
kswedberg Oct 15, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions entries/jQuery.Animation.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?xml version="1.0"?>
<entry name="jQuery.Animation" type="method" return="Promise">
<title>jQuery.Animation()</title>
<signature>
<added>1.8</added>
<argument name="progressCallbacks" type="Function">
<desc>
A function, or array of functions, that is called when the Deferred generates progress notifications.
</desc>
</argument>
</signature>
<desc> </desc>
<longdesc>
<p>
The <code>jQuery.Tween</code> function is called internally by <code>.animate()</code>. It is provided mostly for plugin authors to further customize animations.
</p>
<p>The <code>jQuery.Tween</code> function returns a Tween object with the following properties:</p>
<ul>
<li><strong>elem</strong>: The animated DOM element</li>
<li><strong>prop</strong>: The property being animated</li>
<li><strong>easing</strong>: A string representing the easing being used</li>
<li><strong>start</strong>: A number representing the starting value of the tween</li>
<li><strong>now</strong>: A number representing the current value of the tween</li>
<li><strong>end</strong>: A number representing the ending value of the tween</li>
<li><strong>unit</strong>: A string representing the CSS unit for the tween</li>
<li><strong>options</strong>: A reference to the animation options object</li>
<li><strong>cur()</strong>: A function that reads the current value of the animated property from the element</li>
</ul>

</longdesc>
<category slug="effects/custom-effects"/>
<category slug="version/1.8"/>
</entry>
33 changes: 33 additions & 0 deletions entries/jQuery.Tween.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?xml version="1.0"?>
<entry name="jQuery.Tween" type="method" return="Tween">
<title>jQuery.Tween()</title>
<signature>
<added>1.8</added>
<argument name="progressCallbacks" type="Function">
<desc>
A function, or array of functions, that is called when the Deferred generates progress notifications.
</desc>
</argument>
</signature>
<desc> </desc>
<longdesc>
<p>
The <code>jQuery.Tween</code> function is called internally by <code>.animate()</code>. It is provided mostly for plugin authors to further customize animations.
</p>
<p>The <code>jQuery.Tween</code> function returns a Tween object with the following properties:</p>
<ul>
<li><strong>elem</strong>: The animated DOM element</li>
<li><strong>prop</strong>: The property being animated</li>
<li><strong>easing</strong>: A string representing the easing being used</li>
<li><strong>start</strong>: A number representing the starting value of the tween</li>
<li><strong>now</strong>: A number representing the current value of the tween</li>
<li><strong>end</strong>: A number representing the ending value of the tween</li>
<li><strong>unit</strong>: A string representing the CSS unit for the tween</li>
<li><strong>options</strong>: A reference to the animation options object</li>
<li><strong>cur()</strong>: A function that reads the current value of the animated property from the element</li>
</ul>

</longdesc>
<category slug="effects/custom-effects"/>
<category slug="version/1.8"/>
</entry>
59 changes: 44 additions & 15 deletions includes/options-argument.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,12 @@
<!-- no parameters -->
</property>
<property name="step" type="Function">
<desc>A function to be called after each step of the animation.</desc>
<desc>A function to be called for each animated property of each animated element. This function provides an opportunity to modify the Tween object to change the value of the property before it is set.</desc>
<argument name="now" type="Number">
<desc>The numeric value of the property being animated at each step</desc>
</argument>
<argument name="fx" type="PlainObject">
<desc>A map of properties related to the animation and the element being animated</desc>
<property name="elem" type="DOM">
<desc>The animated element</desc>
</property>
<property name="start" type="Number">
<desc>The first value of the animated property</desc>
</property>
<property name="end" type="Number">
<desc>The last value of the animated property</desc>
</property>
<property name="prop" type="String">
<desc>The property being animated</desc>
</property>
<argument name="tween" type="Tween">
<desc>An object of properties related to the animation and the element being animated. For information about the tween object and its properties, see <a href="/jQuery.Tween/">jQuery.Tween</a></desc>
</argument>
</property>
<property name="queue" type="Boolean" default="true">
Expand All @@ -40,4 +28,45 @@
<property name="specialEasing" type="PlainObject" added="1.4">
<desc>A map of one or more of the CSS properties defined by the properties argument and their corresponding easing functions.</desc>
</property>

<property name="progress" type="Function" added="1.8">
<desc>A function to be called after each step of the animation, only once per animated element regardless of the number of animated properties.</desc>
<argument name="animation" type="Promise">
<desc>An enhanced Promise oject with additional properties for the animation</desc>
</argument>
<argument name="progress" type="Number">
<desc>A number from 0 to 1 indicating the progress of the animation</desc>
</argument>
<argument name="remainingMs" type="Number">
<desc>A number indicating the remaining number of milliseconds until the scheduled end of the animation</desc>
</argument>
</property>
<property name="done" type="Function" added="1.8">
<desc>A function to be called when the animation completes (its Promise object is resolved).</desc>
<argument name="animation" type="Promise">
<desc>An enhanced Promise oject with additional properties for the animation</desc>
</argument>
<argument name="jumpedToEnd" type="Boolean">
<desc>Indicates whether the animation jumped to the end</desc>
</argument>
</property>
<property name="fail" type="Function" added="1.8">
<desc>A function to be called when the animation fails to complete (its Promise object is rejected).</desc>
<argument name="animation" type="Promise">
<desc>An enhanced Promise oject with additional properties for the animation</desc>
</argument>
<argument name="jumpedToEnd" type="Boolean">
<desc>Indicates whether the animation jumped to the end</desc>
</argument>
</property>
<property name="always" type="Function" added="1.8">
<desc>A function to be called when the animation completes or stops without completing (its Promise object is either resolved or rejected).</desc>
<argument name="animation" type="Promise">
<desc>An enhanced Promise oject with additional properties for the animation</desc>
</argument>
<argument name="jumpedToEnd" type="Boolean">
<desc>Indicates whether the animation jumped to the end</desc>
</argument>
</property>

</argument>