Project

General

Profile

Statistics
| Revision:

root / trunk / web / dojo / dojox / fx / README @ 11

History | View | Annotate | Download (2.75 KB)

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
-------------------------------------------------------------------------------
18
Project description
19

    
20
	dojox.fx provides a class of animation effects to use, and
21
	other animation and Effects additions to dojo base.
22

    
23
-------------------------------------------------------------------------------
24
Dependencies:
25

    
26
	dojox.fx requires dojo (core) and the dojo.fx package
27
	dojox.fx.easing is deprecated, and exists in dojo.fx.easing. 
28
	dojox.fx.flip requires dojo.fx
29
	dojox.fx.scroll requires dojox.fx._core and dojo.fx
30

    
31
-------------------------------------------------------------------------------
32
Documentation
33

    
34
	existing API surface: 
35

    
36
	dojox.fx._base:
37
	- dojox.fx.crossFade - crossfade two nodes easily
38
	- dojox.fx.sizeTo - size a node about it's center to a new width/height
39
	- dojox.fx.slideBy - slide a node by a t,l offset
40
	- dojox.fx.highlight - animates the background color of a node, and returns
41
		it to the color it was. 
42

    
43
	(all use standard Animation properties, like duration, easing, node, etc)
44

    
45
	dojox.fx._core:
46
	- dojox.fx._Line - a multi-dimensional _Line implementation, backwards compatible with
47
		dojo._Line ... you might could safely do something akin to
48
		dojo._Line = dojox.fx._Line;
49
		and enable this for all dojo Animations?
50

    
51
	dojox.fx.style: - experimental CSS animation via class definitions
52
	- dojox.fx.addClass - animate the effects of applying a class to a node
53
	- dojox.fx.removeClass - "   "    "    "   removing a class from a node
54
	- dojox.fx.toggleClass - wrapper for addClass/removeClass
55

    
56
	dojox.fx.ext-dojo.NodeList - extensions to dojo.NodeList-fx wrapping the
57
		relevant dojox.fx animations into dojo.NodeList 
58

    
59
	dojox.fx.Shadow - Class to add drop shadows to a node
60

    
61
	dojox.fx.flip - a Module providing pseudo-3d flip animations for nodes.
62
		Currently experimental. 
63

    
64
-------------------------------------------------------------------------------
65
Installation instructions
66

    
67
Grab the following from the Dojo SVN Repository:
68
http://svn.dojotoolkit.org/dojo/dojox/trunk/fx.js
69
http://svn.dojotoolkit.org/dojo/dojox/trunk/fx/*
70

    
71
Install into the following directory structure:
72
/dojox/fx/
73

    
74
...which should be at the same level as your Dojo checkout.
75
-------------------------------------------------------------------------------