Merge pull request #15 from joshuapaling/add-defer-til-window-load-option

Resize immediately by default. Add option to defer til window.load

Author: PaulSpr

README.md

@@ -9,15 +9,17 @@ Usage
 
 Simply include this file in your project (after loading jQuery) like this:
 
-<script defer src="js/jquery.flexverticalcenter.js"></script>
+```<script defer src="js/jquery.flexverticalcenter.js"></script>```
 
 Then call the plugin on the element which needs to be vertically centered in it's parent.
 
+```
   <script>
   $(document).ready(function() {
     $('#element-to-be-centered').flexVerticalCenter();
   });
   </script>
+```
 
 This will take the parents height, the elements own height and calculate the distance the element should have from the parents top to be vertically centered. This value is applied to the top margin of the element by default.
 
@@ -30,17 +32,20 @@ You can pass an options hash to the plugin.
  - `onAttribute` - the css attribute that the value should be set on (default: 'margin-top')
  - `verticalOffset` - the number of pixels to offset the vertical alignment by, ie. 10, "50px", -100 (default: 0)
  - `parentSelector` - a selector representing the parent to vertically center this element within, ie. ".parent" (default: the element's immediate parent)
+ - `debounceTimeout` - in milliseconds, used to rate-limit the vertical centering when resizing the browser window (default: 25)
+ - `deferTilWindowLoad` - if true, no action will be taken until jQuery's window.load event fires. If false, the vertical centering will take place immediately, and then once again on window.load (default: false)
 
 Examples:
 
+```
   <script>
   $(document).ready(function() {
     $('#element-to-be-centered').flexVerticalCenter();
     $('#element-to-be-centered').flexVerticalCenter({ cssAttribute: 'padding-top', verticalOffset: '50px' });
     $('#element-to-be-centered').flexVerticalCenter({ cssAttribute: 'padding-top', parentSelector: '.parent' });
   });
   </script>
-
+```
 
 Non-jQuery version
 ------------------
@@ -51,4 +56,4 @@ Matthew Nessworthy has made a vanilla javascript version of this plugin. Great i
 Note
 ----
 
-The initial code was more or less borrowed from the awesome FitText plugin. http://fittextjs.com/
+The initial code was more or less borrowed from the awesome FitText plugin. http://fittextjs.com/

jquery.flexverticalcenter.js

@@ -15,7 +15,8 @@
       cssAttribute:   'margin-top', // the attribute to apply the calculated value to
       verticalOffset: 0,            // the number of pixels to offset the vertical alignment by
       parentSelector: null,         // a selector representing the parent to vertically center this element within
-      debounceTimeout: 25           // a default debounce timeout in milliseconds
+      debounceTimeout: 25,          // a default debounce timeout in milliseconds
+      deferTilWindowLoad: false     // if true, nothing will take effect until the $(window).load event
     }, options || {});
 
     return this.each(function(){
@@ -39,16 +40,18 @@
           debounce = setTimeout(resizer, settings.debounceTimeout);
       });
 
-      // Call once to set after window loads.
+      if (!settings.deferTilWindowLoad) {
+        // call it once, immediately.
+        resizer();
+      }
+
+      // Call again to set after window (frames, images, etc) loads.
       $(window).load(function () {
           resizer();
       });
 
-      // Apply a load event to images within the element so it fires again after an image is loaded
-      $this.find('img').load(resizer);
-
     });
 
   };
 
-})( jQuery );
+})( jQuery );