Changeset 1546 for trunk/Docs/Fx/Fx.md

Timestamp:

05/05/08 10:36:32 (1 week ago)

Author:

JanK

Message:

• Class events should now be used without their on prefix, i.e. addEvent('onChainComplete', fn) becomes addEvent('chainComplete'). If you want to add events in the options you need to prefix them with 'on' now ('foo' -> 'onFoo').
  

Note: This is not a breaking change.

- other minor optimizations and doc fixes

Files:

• trunk/Docs/Fx/Fx.md (modified) (3 diffs)

trunk/Docs/Fx/Fx.md

@@ -40 +40 @@
 ### Events:
 
-* onStart               - (*function*) The function to execute when the effect begins.
-* onCancel              - (*function*) The function to execute when you manually stop the effect.
-* onComplete            - (*function*) The function to execute after the effect has processed.
-* onChainComplete       - (*function*) The function to execute when using link 'chain' ([see options](#Fx:constructor)). It gets called after all effects in the chain have completed.
+* start                 - (*function*) The function to execute when the effect begins.
+* cancel                - (*function*) The function to execute when you manually stop the effect.
+* complete              - (*function*) The function to execute after the effect has processed.
+* chainComplete - (*function*) The function to execute when using link 'chain' ([see options](#Fx:constructor)). It gets called after all effects in the chain have completed.
 
 ### Notes:
@@ -59 +59 @@
 ----------------------------
 
-The start method is used to begin a transition.  Fires the onStart event.
+The start method is used to begin a transition.  Fires the 'start' event.
 
 ### Syntax:
@@ -111 +111 @@
 ------------------------------
 
-The cancel method is used to cancel a running transition.  Fires the onCancel event.
+The cancel method is used to cancel a running transition.  Fires the 'cancel' event.
 
 ### Syntax: