Skip to content

Updating the queue property to indicate both types it accepts #294

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 2 commits into from
Closed

Updating the queue property to indicate both types it accepts #294

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f5b2f9a
animate(): Clarify that the queue property can be a Boolean or a String.
tjvantoll May 7, 2013
fa55d33
Trivial spelling fixes.
tjvantoll May 7, 2013
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
12 changes: 7 additions & 5 deletions includes/options-argument.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,10 @@
<property name="easing" type="String" default="swing">
<desc>A string indicating which easing function to use for the transition.</desc>
</property>
<property name="queue" type="Boolean" default="true">
<property name="queue" 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>
<type name="Boolean"/>
<type name="String"/>
</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>
Expand All @@ -29,7 +31,7 @@
<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>
<desc>An enhanced Promise object 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>
Expand All @@ -45,7 +47,7 @@
<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>
<desc>An enhanced Promise object with additional properties for the animation</desc>
</argument>
<argument name="jumpedToEnd" type="Boolean">
<desc>Indicates whether the animation jumped to the end</desc>
Expand All @@ -54,7 +56,7 @@
<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>
<desc>An enhanced Promise object with additional properties for the animation</desc>
</argument>
<argument name="jumpedToEnd" type="Boolean">
<desc>Indicates whether the animation jumped to the end</desc>
Expand All @@ -63,7 +65,7 @@
<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>
<desc>An enhanced Promise object with additional properties for the animation</desc>
</argument>
<argument name="jumpedToEnd" type="Boolean">
<desc>Indicates whether the animation jumped to the end</desc>
Expand Down