Merge pull request #305 from fieg/auto-initialize

Added initialize option

Author: fieg

doc/options.md

@@ -83,3 +83,17 @@ For example:
 Setting a `negativeMargin` of 250 means that IAS will start loading 250 pixel before the last item has scrolled into view.
 
 Note: user experience can degrade if new pages are loaded too quickly without visual feedback (also see [delay](options.html#delay)). Use with caution.
+
+### initialize
+
+<dl>
+    <dt>Type</dt>
+    <dd>boolean</dd>
+
+    <dt>Default</dt>
+    <dd>true</dd>
+</dl>
+
+By default IAS initializes when the document is ready. During initialisation IAS binds to the scroll event and prefills the container when the content is shorter then the page fold.
+
+If you want to control when IAS initializes yourself, you can set this value to false.

src/jquery-ias.js

@@ -487,6 +487,12 @@
 
     this.listeners[event].add($.proxy(callback, this), priority);
 
+    // ready is already fired, before on() could even be called, so
+    // let's call the callback right away
+    if (event === 'ready' && this.isInitialized) {
+      $.proxy(callback, this)();
+    }
+
     return this;
   };
 
@@ -627,7 +633,9 @@
       if (!instance) {
         $this.data('ias', (instance = new IAS($this, options)));
 
-        $(document).ready($.proxy(instance.initialize, instance));
+        if (options.initialize) {
+          $(document).ready($.proxy(instance.initialize, instance));
+        }
       }
 
       // when the plugin is called with a method
@@ -658,6 +666,7 @@
     next: '.next',
     pagination: false,
     delay: 600,
-    negativeMargin: 10
+    negativeMargin: 10,
+    initialize: true
   };
 })(jQuery);

test/08-auto-initialize-test.js

@@ -0,0 +1,56 @@
+describe("auto initialize", function () {
+  before(function() {
+    this.timeout = 10000;
+
+    window.scrollTo(0, 0);
+  });
+
+  after(function() {
+    jQuery.ias('destroy');
+  });
+
+  it("should initialize", function() {
+    var deferred = when.defer();
+    var spy = this.spy();
+
+    var ias = jQuery.ias({
+      container : '.listing',
+      item: '.post',
+      pagination: '.navigation',
+      next: '.next-posts a'
+    });
+
+    ias.on('ready', spy);
+
+    wait(300).then(function() {
+      expect(spy).toHaveBeenCalledOnce();
+
+      deferred.resolve();
+    });
+
+    return deferred.promise;
+  });
+
+  it("should not initialize", function() {
+    var deferred = when.defer();
+    var spy = this.spy();
+
+    var ias = jQuery.ias({
+      container : '.listing',
+      item: '.post',
+      pagination: '.navigation',
+      next: '.next-posts a',
+      initialize: false
+    });
+
+    ias.on('ready', spy);
+
+    wait(300).then(function() {
+      expect(spy).not.toHaveBeenCalled();
+
+      deferred.resolve();
+    });
+
+    return deferred.promise;
+  });
+});