From 1e66bf2cf8f7ac3ac663e540a92a5b286f6d0147 Mon Sep 17 00:00:00 2001 From: TJ VanToll Date: Fri, 3 May 2013 23:51:57 -0400 Subject: [PATCH] Class Animation: Document alternative object hash based signature. Fixes #101 - Document children option for class animation methods. --- entries/addClass.xml | 6 +++++ entries/removeClass.xml | 6 +++++ entries/switchClass.xml | 9 ++++++++ entries/toggleClass.xml | 9 ++++++++ includes/class-animation-argument-options.xml | 22 +++++++++++++++++++ 5 files changed, 52 insertions(+) create mode 100644 includes/class-animation-argument-options.xml diff --git a/entries/addClass.xml b/entries/addClass.xml index 95d786d4..328b3159 100644 --- a/entries/addClass.xml +++ b/entries/addClass.xml @@ -14,6 +14,12 @@ + + + One or more class names (space separated) to be added to the class attribute of each matched element. + + + Adds the class "big-blue" to the matched elements. + + + One or more class names (space separated) to be removed from the class attribute of each matched element. + + + Removes the class "big-blue" from the matched elements. + + + One or more class names (space separated) to be removed from the class attribute of each matched element. + + + One or more class names (space separated) to be added to the class attribute of each matched element. + + + 220 Adds the class "blue" and removes the class "big" from the matched elements. diff --git a/entries/toggleClass.xml b/entries/toggleClass.xml index 0ade01a1..3ae231bb 100644 --- a/entries/toggleClass.xml +++ b/entries/toggleClass.xml @@ -17,6 +17,15 @@ + + + One or more class names (space separated) to be toggled for each element in the matched set. + + + A boolean value to determine whether the class should be added or removed. + + + 220 Toggles the class "big-blue" for the matched elements. diff --git a/includes/class-animation-argument-options.xml b/includes/class-animation-argument-options.xml new file mode 100644 index 00000000..d578830b --- /dev/null +++ b/includes/class-animation-argument-options.xml @@ -0,0 +1,22 @@ + + + All animation settings. All properties are optional. + + A string or number determining how long the animation will run. + + The duration in milliseconds. + + + The strings "fast" and "slow" can be supplied to indicate durations of 200 and 600 milliseconds, respectively. + + + + A string indicating which easing function to use for the transition. + + + A function to call once the animation is complete. + + + Whether the animation should additionally be applied to all children of the matched elements. + + \ No newline at end of file