Skip to content

Commit de03e27

Browse files
committed
Add jQuery 1.8 animation option properties
1 parent 8d17967 commit de03e27

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

includes/options-argument.xml

+42-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<!-- no parameters -->
1515
</property>
1616
<property name="step" type="Function">
17-
<desc>A function to be called after each step of the animation.</desc>
17+
<desc>A function to be called after each step of the animation for each animated element and for each animated property.</desc>
1818
<argument name="now" type="Number">
1919
<desc>The numeric value of the property being animated at each step</desc>
2020
</argument>
@@ -40,4 +40,45 @@
4040
<property name="specialEasing" type="PlainObject" added="1.4">
4141
<desc>A map of one or more of the CSS properties defined by the properties argument and their corresponding easing functions.</desc>
4242
</property>
43+
44+
<property name="progress" type="Function" added="1.8">
45+
<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>
46+
<argument name="animation" type="Promise">
47+
<desc>An enhanced Promise oject with additional properties for the animation</desc>
48+
</argument>
49+
<argument name="progress" type="Number">
50+
<desc>A number from 0 to 1 indicating the progress of the animation</desc>
51+
</argument>
52+
<argument name="remainingMs" type="Number">
53+
<desc>A number indicating the remaining number of milliseconds until the end of the animation</desc>
54+
</argument>
55+
</property>
56+
<property name="done" type="Function" added="1.8">
57+
<desc>A function to be called when the animation completes (its Promise object is resolved).</desc>
58+
<argument name="animation" type="Promise">
59+
<desc>An enhanced Promise oject with additional properties for the animation</desc>
60+
</argument>
61+
<argument name="jumpedToEnd" type="Boolean">
62+
<desc>Indicates whether the animation jumped to the end</desc>
63+
</argument>
64+
</property>
65+
<property name="fail" type="Function" added="1.8">
66+
<desc>A function to be called when the animation fails to complete (its Promise object is rejected).</desc>
67+
<argument name="animation" type="Promise">
68+
<desc>An enhanced Promise oject with additional properties for the animation</desc>
69+
</argument>
70+
<argument name="jumpedToEnd" type="Boolean">
71+
<desc>Indicates whether the animation jumped to the end</desc>
72+
</argument>
73+
</property>
74+
<property name="always" type="Function" added="1.8">
75+
<desc>A function to be called when the animation completes or stops without completing (its Promise object is either resolved or rejected).</desc>
76+
<argument name="animation" type="Promise">
77+
<desc>An enhanced Promise oject with additional properties for the animation</desc>
78+
</argument>
79+
<argument name="jumpedToEnd" type="Boolean">
80+
<desc>Indicates whether the animation jumped to the end</desc>
81+
</argument>
82+
</property>
83+
4384
</argument>

0 commit comments

Comments
 (0)