Changeset 1546 for trunk/Docs/Plugins/Tips.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/Plugins/Tips.md (modified) (5 diffs)

trunk/Docs/Plugins/Tips.md

@@ -26 +26 @@
 ### Options:
 
-* showDelay     - (*number*: defaults to 100) The delay the onShow method is called.
-* hideDelay     - (*number*: defaults to 100) The delay the onHide method is called.
+* showDelay     - (*number*: defaults to 100) The delay the show event is fired.
+* hideDelay     - (*number*: defaults to 100) The delay the hide hide is fired.
 * className     - (*string*: defaults to null) the className your tooltip container will get. Useful for extreme styling.
  * The tooltip element inside the tooltip container above will have 'tip' as classname.
@@ -38 +38 @@
 ### Events:
  
- * onHide: fires when the tip is shown
- * onShow: fires when the tip is being hidden
+ * hide: fires when the tip is shown
+ * show: fires when the tip is being hidden
 
 ### Example:
@@ -52 +52 @@
         
 
-Tips Event: onShow {#Tips:onShow}
+Tips Event: show {#Tips:show}
 ---------------------------------
 
@@ -67 +67 @@
 ### Example:
 
-        myTips.addEvent('onShow', function(tip){
+        myTips.addEvent('show', function(tip){
                 tip.fade('in');
         });
 
-Tips Event: onHide {#Tips:onHide}
+Tips Event: hide {#Tips:hide}
 ---------------------------------
 
@@ -86 +86 @@
 ### Example:
 
-        myTips.addEvent('onHide', function(tip){
+        myTips.addEvent('hide', function(tip){
                 tip.fade('out');
         });