Class Animation: Document alternative object hash based signature. Fixes

#101 - Document children option for class animation methods.
jquery · May 6, 2013 · b26f292 · b26f292
1 parent 4f69c59
commit b26f292
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 0 deletions.
diff --git a/entries/addClass.xml b/entries/addClass.xml
@@ -14,6 +14,12 @@
 		<xi:include href="../includes/animation-argument-easing.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
 		<xi:include href="../includes/animation-argument-complete.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
 	</signature>
+	<signature>
+		<argument name="className" type="String">
+			<desc>One or more class names (space separated) to be added to the class attribute of each matched element.</desc>
+		</argument>
+		<xi:include href="../includes/class-animation-argument-options.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
+	</signature>
 	<example>
 		<desc>Adds the class "big-blue" to the matched elements.</desc>
 		<css><![CDATA[

diff --git a/entries/removeClass.xml b/entries/removeClass.xml
@@ -14,6 +14,12 @@
 		<xi:include href="../includes/animation-argument-easing.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
 		<xi:include href="../includes/animation-argument-complete.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
 	</signature>
+	<signature>
+		<argument name="className" type="String">
+			<desc>One or more class names (space separated) to be removed from the class attribute of each matched element.</desc>
+		</argument>
+		<xi:include href="../includes/class-animation-argument-options.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
+	</signature>
 	<example>
 		<desc>Removes the class "big-blue" from the matched elements.</desc>
 		<css><![CDATA[

diff --git a/entries/switchClass.xml b/entries/switchClass.xml
@@ -18,6 +18,15 @@
 		<xi:include href="../includes/animation-argument-easing.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
 		<xi:include href="../includes/animation-argument-complete.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
 	</signature>
+	<signature>
+		<argument name="removeClassName" type="String">
+			<desc>One or more class names (space separated) to be removed from the class attribute of each matched element.</desc>
+		</argument>
+		<argument name="addClassName" type="String">
+			<desc>One or more class names (space separated) to be added to the class attribute of each matched element.</desc>
+		</argument>
+		<xi:include href="../includes/class-animation-argument-options.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
+	</signature>
 	<example>
 		<height>220</height>
 		<desc>Adds the class "blue" and removes the class "big" from the matched elements.</desc>

diff --git a/entries/toggleClass.xml b/entries/toggleClass.xml
@@ -17,6 +17,15 @@
 		<xi:include href="../includes/animation-argument-easing.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
 		<xi:include href="../includes/animation-argument-complete.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
 	</signature>
+	<signature>
+		<argument name="className" type="String">
+			<desc>One or more class names (space separated) to be toggled for each element in the matched set.</desc>
+		</argument>
+		<argument name="switch" type="Boolean" optional="true">
+			<desc>A boolean value to determine whether the class should be added or removed.</desc>
+		</argument>
+		<xi:include href="../includes/class-animation-argument-options.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
+	</signature>
 	<example>
 		<height>220</height>
 		<desc>Toggles the class "big-blue" for the matched elements.</desc>

diff --git a/includes/class-animation-argument-options.xml b/includes/class-animation-argument-options.xml
@@ -0,0 +1,22 @@
+<?xml version="1.0"?>
+<argument name="options" type="Object" optional="true">
+	<desc>All animation settings. All properties are optional.</desc>
+	<property name="duration" default="400" optional="true">
+		<desc>A string or number determining how long the animation will run.</desc>
+		<type name="Number">
+			<desc>The duration in milliseconds.</desc>
+		</type>
+		<type name="String">
+			<desc>The strings <code>"fast"</code> and <code>"slow"</code> can be supplied to indicate durations of 200 and 600 milliseconds, respectively.</desc>
+		</type>
+	</property>
+	<property name="easing" type="String" default="swing" optional="true">
+		<desc>A string indicating which <a href="/easings/">easing</a> function to use for the transition.</desc>
+	</property>
+	<property name="complete" type="Function" optional="true">
+		<desc>A function to call once the animation is complete.</desc>
+	</property>
+	<property name="children" type="Boolean" default="false">
+		<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>
+	</property>
+</argument>