dojox/fx/style.js

• Provides:

  • dojox.fx.style

• Requires:

  • dojo.fx in common

• dojox.fx.addClass

  • parameters:
    • node: (typeof String|DomNode)

      A String ID or DomNode referce to animate

    • cssClass: (typeof String)

      The CSS class name to add to the node

    • args: (typeof Object)

      Additional optional <code>dojo.animateProperty</code> arguments, such as
      duration, easing and so on.

  • returns

    dojo.Animation

  • summary

    Animate the effects of adding a class to a node

  • description

    Creates an animation that will animate
    the properties of a node to the properties
    defined in a standard CSS .class definition.
    (calculating the differences itself)

  • example

    	.bar { line-height: 12px; }
    	.foo { line-height: 40px; }
    	<div class="bar" id="test">
    	Multi<br>line<br>text
    	</div>
    
    	// animate to line-height:40px
    	dojo.fx.addClass("test", "foo").play();

  • type

    Function

• dojox.fx.removeClass

  • parameters:
    • node
    • cssClass
    • args
  • returns

    dojo.Animation

  • summary

    Animate the effects of removing a class from a node

  • description

    Creates an animation that will animate the properties of a
    node (args.node) to the properties calculated after removing
    a standard CSS className from a that node.
    
    calls dojo.removeClass(args.cssClass) onEnd of animation
    
    standard dojo.Animation object rules apply.

  • example

    	// animate the removal of "foo" from a node with id="bar"
    	dojox.fx.removeClass("bar", "foo").play()

  • type

    Function

• dojox.fx.toggleClass

  • parameters:
    • node: (typeof String|DomNode)

      The domNode (or string of the id) to toggle

    • cssClass: (typeof String)

      String of the classname to add to the node

    • condition: (typeof Boolean)

      If passed, true means to add the class, false means to remove.

    • args: (typeof Object)

      Additional <code>dojo.Animation</code> args to pass along.

  • returns

    dojo.Animation

  • summary

    Animate the effects of Toggling a class on a Node

  • description

    creates an animation that will animate the effect of
    toggling a class on or off of a node.
    Adds a class to node if not present, or removes if present.
    Pass a boolean condition if you want to explicitly add or remove.

  • example

    	// add the class "sampleClass" to a node id="theNode"
    	dojox.fx.toggleClass("theNode","sampleClass",true).play();

  • example

    	// toggle the class "sampleClass" on the node id="theNode"
    	dojox.fx.toggleClass("theNode","sampleClass").play();

  • type

    Function

• dojox.fx._allowedProperties

  • type

    Array

• dojo

  • alias - dojo

• dojox.fx.style

  • type

    Object

• dojox.fx

  • type

    Object

• dojox

  • type

    Object