Browse files

Extend effects category description

  • Loading branch information...
1 parent 313853a commit c832f5ac0acc836dc5b11fed4aa079335784b941 @jzaefferer jzaefferer committed Jun 19, 2012
Showing with 8 additions and 1 deletion.
  1. +8 −1 categories.xml
View
9 categories.xml
@@ -3,7 +3,14 @@
<desc>
<![CDATA[
Effects include extensions to jQuery's built-in animate method, providing support for animating colors and doing transitions from one class to another.
- <p>Effects also add, to jQuery's built-in linear and swing transitions, a bunch of easings.</p>
+ <p>For class transitions, <code>addClass(class)</code>, <code>removeClass(class)</code>, <code>toggleClass(class)</code> and <code>toggleClass(switch)</code> are each extended to accept three additional parameters: <code>speed</code>, <code>easing</code> (optional), and <code>callback</code>.</p>
+ <p>In addition, a <code>switchClass</code> method is added, alllowing you to visually transition from one class to another. (This functionality is often described as 'animateClass'.)</p>
+ <pre><code>$(elem).switchClass('currentClass','newClass',500,'easeOutBounce',function(){
+ console.log('transition is done!');
+});</code></pre>
+ <p>Similar to the extension of the class-related methods, the <code>show</code>, <code>hide</code> and <code>toggle</code> methods are extended. Each can now accept configuration for the effects listed below, as <code>effect</code> (what effect to use, like "blind", <code>options</code> (effect specific configuration), <code>duration</code>, and <code>callback</code>. For effects like <code>transfer</code>, where neither a show nor hide happens, you can use the underlying <code>effect</code> method directly. The signature is the same.
+ <p>For color animation support, jQuery UI bundles the <a href="https://github.com/jquery/jquery-color">jquery-color plugin</a>. The plugin extends jQuery's <code>animate</code> method with support for animating the following properties: <code>backgroundColor, borderBottomColor, borderLeftColor, borderRightColor, borderTopColor, color, outlineColor</code>
+ <p>Effects also add, to jQuery's built-in linear and swing transitions, a bunch of easings. The full list: <code>linear, swing, easeInQuad, easeOutQuad, easeInOutQuad, easeInCubic, easeOutCubic, easeInOutCubic, easeInQuart, easeOutQuart, easeInOutQuart, easeInQuint, easeOutQuint, easeInOutQuint, easeInExpo, easeOutExpo, easeInOutExpo, easeInSine, easeOutSine, easeInOutSine, easeInCirc, easeOutCirc, easeInOutCirc, easeInElastic, easeOutElastic, easeInOutElastic, easeInBack, easeOutBack, easeInOutBack, easeInBounce, easeOutBounce, easeInOutBounce</code></p>
]]>
</desc>
</category>

0 comments on commit c832f5a

Please sign in to comment.