Skip to content

Commit a645b6a

Browse files
committed
Effects: Documenting the queue property for the effects options argument. Fixes jquery#118.
(cherry picked from commit dc05ed6dd23c6792cf954453ae26ae8e2320396f)
1 parent 4dc1525 commit a645b6a

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

includes/animation-signature-options.xml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,10 @@
2020
<property name="complete" type="Function">
2121
<desc>A function to call once the animation is complete.</desc>
2222
</property>
23+
<property name="queue" default="true">
24+
<type name="Boolean"/>
25+
<type name="String"/>
26+
<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>
27+
</property>
2328
</argument>
2429
</signature>

includes/class-animation-argument-options.xml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,9 @@
1919
<property name="children" type="Boolean" default="false">
2020
<desc>Whether the animation should additionally be applied to all descendants of the matched elements. This feature should be used with caution as the cost of determining which descendants to animate can be very expensive, and grows linearly with the number of descendants.</desc>
2121
</property>
22+
<property name="queue" default="true">
23+
<type name="Boolean"/>
24+
<type name="String"/>
25+
<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>
26+
</property>
2227
</argument>

0 commit comments

Comments
 (0)