Merge pull request #306 from fieg/arbitrary-ajax-settings

Use the loadEvent object to provide arbitrary $.get settings

Author: fieg

doc/events.md

@@ -20,18 +20,35 @@ Triggered when a new page is about to be loaded from the server.
 
 The load event object contains the following properties.
 
-| property  | type          | description             |
-|-----------|---------------|-------------------------|
-| event.url | string        | url that will be loaded |
+| property          | type   | description                                                                    |
+|-------------------|--------|--------------------------------------------------------------------------------|
+| event.url         | string | url that will be loaded                                                        |
+| event.ajaxOptions | object | options that are passed to [$.ajax method](http://api.jquery.com/jquery.ajax/) |
 
 Using this event it is possible to change the requested url. This can be useful to append an arbitrary parameter to the requested url so the server can handle the request differently. For example to optimize the returned html by stripping everything outside the container element (header, footer, etc.).
 
 ```javascript
 ias.on('load', function(event) {
     event.url = event.url + "?ajax=1";
+
+    // alternatively...
+    event.ajaxOptions.data = { ajax: 1 };
+})
+```
+
+The ajaxOptions property can also be used for more exotic configurations.
+
+```javascript
+ias.on('load', function(event) {
+    // A more exotic example, timeout and HTTP auth
+    event.timeout = 7000; //ms
+    event.username = 'shirley';
+    event.password = 'temple';
 })
 ```
 
+See http://api.jquery.com/jquery.ajax/ for a complete list of options.
+
 ### loaded
 
 | argument | type   | description             |

src/jquery-ias.js

@@ -182,12 +182,15 @@
       delay = delay || this.defaultDelay;
 
       var loadEvent = {
-        url: url
+        url: url,
+        ajaxOptions: {
+          dataType: 'html'
+        }
       };
 
       self.fire('load', [loadEvent]);
 
-      this.jsXhr = $.get(loadEvent.url, null, $.proxy(function(data) {
+      function xhrDoneCallback(data) {
         $itemContainer = $(this.itemsContainerSelector, data).eq(0);
         if (0 === $itemContainer.length) {
           $itemContainer = $(data).filter(this.itemsContainerSelector).eq(0);
@@ -211,7 +214,10 @@
             callback.call(self, data, items);
           }
         }
-      }, self), 'html');
+      }
+
+      this.jsXhr = $.ajax(loadEvent.url, loadEvent.ajaxOptions)
+        .done($.proxy(xhrDoneCallback, self));
 
       return this.jsXhr;
     };