Skip to content

Commit

Permalink
Include effects options added in jQuery 1.8.
Browse files Browse the repository at this point in the history 
Closes #81
  • Loading branch information
@kswedberg
kswedberg committed Feb 24, 2013
1 parent e4d98e5 commit ede5fb7
Showing 1 changed file with 52 additions and 22 deletions.
74 changes: 52 additions & 22 deletions includes/options-argument.xml
View file
Expand Up @@ -9,35 +9,65 @@
<property name="easing" type="String" default="swing">
<desc>A string indicating which easing function to use for the transition.</desc>
</property>
<property name="complete" type="Function">
<desc>A function to call once the animation is complete.</desc>
<!-- no parameters -->
<property name="queue" type="Boolean" default="true">
<desc>A Boolean indicating whether to place the animation in the effects queue. If false, the animation will begin immediately. <strong>As of jQuery 1.7</strong>, the queue option can also accept a string, in which case the animation is added to the queue represented by that string.</desc>
</property>
<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="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">
<desc>A Boolean indicating whether to place the animation in the effects queue. If false, the animation will begin immediately. <strong>As of jQuery 1.7</strong>, the queue option can also accept a string, in which case the animation is added to the queue represented by that string.</desc>

<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="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 name="complete" type="Function">
<desc>A function to call once the animation is complete.</desc>
<!-- no parameters -->
</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>

0 comments on commit ede5fb7

Please sign in to comment.