README 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. -------------------------------------------------------------------------------
  2. dojox.fx
  3. -------------------------------------------------------------------------------
  4. Version 1.0.0
  5. Release date: 10/31/2007
  6. -------------------------------------------------------------------------------
  7. Project state:
  8. 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. Nicola Rizzo (nic)
  16. -------------------------------------------------------------------------------
  17. Project description
  18. dojox.fx provides a class of animation effects to use, and
  19. other animation and Effects additions to dojo base.
  20. -------------------------------------------------------------------------------
  21. Dependencies:
  22. dojox.fx requires dojo (core) and the dojo.fx package
  23. dojox.fx.easing is deprecated, and exists in dojo.fx.easing.
  24. dojox.fx.flip requires dojo.fx
  25. dojox.fx.scroll requires dojox.fx._core and dojo.fx
  26. -------------------------------------------------------------------------------
  27. Documentation
  28. existing API surface:
  29. dojox.fx._base:
  30. - dojox.fx.crossFade - crossfade two nodes easily
  31. - dojox.fx.sizeTo - size a node about it's center to a new width/height
  32. - dojox.fx.slideBy - slide a node by a t,l offset
  33. - dojox.fx.highlight - animates the background color of a node, and returns
  34. it to the color it was.
  35. (all use standard Animation properties, like duration, easing, node, etc)
  36. dojox.fx._core:
  37. - dojox.fx._Line - a multi-dimensional _Line implementation, backwards compatible with
  38. dojo._Line ... you might could safely do something akin to
  39. dojo._Line = dojox.fx._Line;
  40. and enable this for all dojo Animations?
  41. dojox.fx.style: - experimental CSS animation via class definitions
  42. - dojox.fx.addClass - animate the effects of applying a class to a node
  43. - dojox.fx.removeClass - " " " " removing a class from a node
  44. - dojox.fx.toggleClass - wrapper for addClass/removeClass
  45. dojox.fx.ext-dojo.NodeList - extensions to dojo.NodeList-fx wrapping the
  46. relevant dojox.fx animations into dojo.NodeList
  47. dojox.fx.Shadow - Class to add drop shadows to a node
  48. dojox.fx.flip - a Module providing pseudo-3d flip animations for nodes.
  49. Currently experimental.
  50. -------------------------------------------------------------------------------
  51. Installation instructions
  52. Grab the following from the Dojo SVN Repository:
  53. http://svn.dojotoolkit.org/dojo/dojox/trunk/fx.js
  54. http://svn.dojotoolkit.org/dojo/dojox/trunk/fx/*
  55. Install into the following directory structure:
  56. /dojox/fx/
  57. ...which should be at the same level as your Dojo checkout.
  58. -------------------------------------------------------------------------------