added explanation of $.fn.elementOptions

wombleton · Jan 1, 2010 · aabc591 · aabc591
1 parent b250fdb
commit aabc591
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/javascripts/jquery.tipsy.js b/src/javascripts/jquery.tipsy.js
@@ -77,6 +77,10 @@
 
     };
 
+    // Overwrite this method to provide options on a per-element basis.
+    // For example, you could store the gravity in a 'tipsy-gravity' attribute:
+    // return $.extend({}, options, {gravity: $(ele).attr('tipsy-gravity') || 'n' });
+    // (remember - do not modify 'options' in place!)
     $.fn.tipsy.elementOptions = function(ele, options) {
         return $.metadata ? $.extend({}, options, $(ele).metadata()) : options;
     };