git.pond.sub.org Git - eow/blob - static/dojo-release-1.1.1/dojox/fx/README

   1 -------------------------------------------------------------------------------
   2 dojox.fx
   3 -------------------------------------------------------------------------------
   4 Version 1.0.0
   5 Release date: 10/31/2007
   6 -------------------------------------------------------------------------------
   7 Project state:
   8 prototype / experimental
   9 -------------------------------------------------------------------------------
  10 Credits
  11         Peter Higgins (dante)
  12         Jonathan Bond-Caron (jbondc@gmail.com)
  13         Shane O'Sullivan (shaneosullivan1@gmail.com)
  14         Bryan Forbes (bforbes)
  15
  16 -------------------------------------------------------------------------------
  17 Project description
  18
  19         dojox.fx provides a class of animation effects to use, and
  20         other animation and Effects additions to dojo base.
  21
  22 -------------------------------------------------------------------------------
  23 Dependencies:
  24
  25         dojox.fx requires dojo (core) and the dojo.fx package
  26         dojox.fx.easing requires only dojo core.
  27         dojox.fx.scroll requires dojox.fx._core and dojo.fx
  28
  29 -------------------------------------------------------------------------------
  30 Documentation
  31
  32         existing API surface:
  33
  34         dojox.fx._base:
  35         - dojox.fx.crossFade - crossfade two nodes easily
  36         - dojox.fx.sizeTo - size a node about it's center to a new width/height
  37         - dojox.fx.slideBy - slide a node by a t,l offset
  38         - dojox.fx.highlight - animates the background color of a node, and returns
  39                 it to the color it was.
  40
  41         (all use standard _Animation properties, like duration, easing, node, etc)
  42
  43         dojox.fx._core:
  44         - dojox.fx._Line - a 2-d _Line implementation, backwards compatible with
  45                 dojo._Line ... you might could safely do something akin to
  46                 dojo._Line.prototype = dojox.fx._Line.prototype;
  47                 and enable this for all dojo _Animations?
  48
  49         dojox.fx.style: - experimental CSS animation via class definitions
  50         - dojox.fx.addClass - animate the effects of applying a class to a node
  51         - dojox.fx.removeClass - "   "    "    "   removing a class from a node
  52         - dojox.fx.toggleClass - wrapper for addClass/removeClass
  53
  54         dojox.fx.easing: - a collection of easing functions to use
  55                 this is a "stand alone" class, and can be used via:
  56                 dojo.require("dojox.fx.easing");
  57                 to use in an _Animation easing: property
  58                 ported/decoded by Bryan Forbes from Robert Penner's Flash easing
  59                 functions, contributed under CLA.
  60
  61         dojox.fx.ext-dojo.NodeList - extensions to dojo.NodeList-fx wrapping the
  62                 relevant dojox.fx animations into dojo.NodeList
  63
  64         dojox.fx.Shadow - Class to add drop shadows to a node
  65
  66 -------------------------------------------------------------------------------
  67 Installation instructions
  68
  69 Grab the following from the Dojo SVN Repository:
  70 http://svn.dojotoolkit.org/dojo/dojox/trunk/fx.js
  71 http://svn.dojotoolkit.org/dojo/dojox/trunk/fx/*
  72
  73 Install into the following directory structure:
  74 /dojox/fx/
  75
  76 ...which should be at the same level as your Dojo checkout.
  77 -------------------------------------------------------------------------------