jqr-helpers 1.0.18 → 1.0.19

data/Readme.md

@@ -49,6 +49,8 @@ the dialog content from a remote route)
 * `tab_container` - create a tab container
 * `date_picker_tag` - create a date picker
 * `buttonset` - create a radio button set
+* `will_paginate_ajax` - create a will_paginate interface that uses Ajax to
+replace the paginated contents.
 
 There are two sets of options that recur throughout the methods here:
 
@@ -57,35 +59,35 @@ There are two sets of options that recur throughout the methods here:
 These are parameters to pass to the `jQuery.dialog()` function.
 See <http://api.jqueryui.com/dialog/>.
 
-An extra custom option is `:title` - setting it to `false` will hide the
-title bar.
+Additional or changed options:
 
-Another thing to note is the special values for buttons. Usually the buttons
-must have JavaScript callbacks, but 99% of the time you want the classic
-OK and Cancel buttons. Passing `submit` and `close` as the values
-of the buttons (or the values of the "click" attribute of the buttons)
-will do just that - submit the form inside the dialog or close it.
+* `:title` - setting this to `false` will hide the title bar.
+* `:buttons`: Usually the buttons must have JavaScript callbacks, but 99% of the
+time you want the classic OK and Cancel buttons. Passing `submit` and `close`
+as the values of the buttons (or the values of the "click" attribute of the
+buttons) will do just that - submit the form inside the dialog or close it.
 
 Example:
 
     button_to_dialog('my-dialog-id', 'Open Dialog', :buttons =>
       {'OK' => 'submit', 'Cancel' => 'close'})
 
-You can also use a special option, `:default_buttons => true`, as a shortcut
-to the above buttons, since it's so common to have an OK and Cancel
-button.
-
-Another option is `:close_x => true` - this will print a green X at the top
+* `:default_buttons`: This is a special option which acts as a shortcut
+to the above example, since it's so common to have an OK and Cancel button.
+* `:close_x => true`: this will print a green X at the top
 right of the dialog. Generally this is used when `:title => false`.
-
-Another option is `:data` - this accepts a hash of string/value pairs. When this
+*`:data`: this accepts a hash of string/value pairs. When this
 is given, jqr-helpers will search the dialog for input fields whose names
 match the keys and populate them with the values. This is helpful when you want
 to pass data to a local dialog but don't want to mess around with saving data
 attributes and callbacks. When using a remote dialog it's easier to just pass
 the data into the URL and have Rails populate it on the server side.
+*`:throbber`: For remote dialogs only. This can be `:small`, `:large`, or
+`:none`. By default it is `:large`, indicating a throbber that goes in front
+of the screen. `:small` would be a small inline throbber next to the button or
+link that called the dialog, and `:none` shows no throbber at all.
 
-Note about dialog ID - you can always pass in the special value `:next` for
+A note about dialog ID - you can always pass in the special value `:next` for
 this. This will use whatever element is just after the clicked element
 for the dialog contents. This can be useful for printing simple dialogs inside a
 foreach loop that shouldn't require a totally separate route + view.
@@ -126,6 +128,13 @@ other elements.
 this indicates that the dialog should be closed when the request completes
 successfully. This is true by default for forms and false for
 other elements.
+* `:scroll_to` (Boolean) - if given, the element that was updated or inserted
+will be scrolled into view (i.e. its top will be aligned with the top of the
+page).
+*`:throbber` (String) - This can be `:small`, `:large`, or
+`:none`. By default it is `:small`, indicating a throbber that goes in front
+of the screen. `:small` would be a small inline throbber next to the button or
+link that called the dialog, and `:none` shows no throbber at all.
 
 ## Panel Renderers ##
 
@@ -149,6 +158,12 @@ populated.
 * `jqr.beforedialogopen` - for remote dialogs, this is triggered when the
 link or button is clicked to open the dialog but before the request is sent out.
 
+## will_paginate ##
+
+jqr-helpers supports an Ajax version of [will_paginate](https://github.com/mislav/will_paginate).
+This replaces each link with an Ajax link and will load the content of the page
+into the supplied element.
+
 ***
 
 jqr-helpers was developed by [Wishabi](http://www.wishabi.com).

data/app/assets/javascripts/jqr-helpers.js

@@ -1,11 +1,20 @@
 (function($) {
   function showThrobber(element) {
-    $(element).after("<img src='/images/jqr-helpers/throbber.gif' class='throbber'/>");
+    switch ($(element).data('throbber')) {
+      case 'none':
+        return;
+      case 'large':
+        $(document.body).append('<div id="ujs-dialog-throbber">');
+        break;
+      default: // small or not given
+        $(element).after("<img src='/images/jqr-helpers/throbber.gif' class='throbber'/>");
+    }
     $(element).attr('disabled', 'disabled');
   }
 
   function hideThrobber(element) {
     $(element).nextAll('.throbber').remove();
+    $('#ujs-dialog-throbber').remove();
     $(element).removeAttr('disabled');
   }
 
@@ -27,11 +36,13 @@
     $(this).css('maxHeight', ($(window).height() * 0.8) + 'px');
     if ($(this).parent().height() > $(window).height()) {
       $(this).height($(window).height() * 0.8);
-      $(this).parent().css('top',
-          Math.max(($(window).height() - $(this).parent().height()) / 2, 1)
-      );
       $(this).css('overflow-y', 'auto');
     }
+    $(this).parent().position({
+      my: 'center',
+      at: 'center',
+      of: $(window)
+    });
     var x = $(this).find('.ujs-dialog-x');
     if (x.length) {
       $(this).parent().append(x); // to keep it fixed to the dialog
@@ -93,7 +104,7 @@
     if (url) {
       $(this).trigger('jqr.beforedialogopen');
       $(document.body).append('<div class="ui-widget-overlay ui-front">');
-      $(document.body).append('<div id="remote-dialog-throbber">');
+      showThrobber(ujsDialogElement);
       var closeX = $(this).data('close-x');
       if (dialogElement.length == 0) {
         $('body').append("<div id='" + dialogID + "'>");
@@ -104,7 +115,8 @@
           dialogElement.prepend('<span class="ujs-dialog-x"></span>');
         }
         $('.ui-widget-overlay').remove();
-        $('#remote-dialog-throbber').remove();
+        hideThrobber(ujsDialogElement);
+        $('#ujs-dialog-throbber').remove();
         $(this).dialog(dialogOptions);
         $(dialogElement).trigger('jqr.load');
       });
@@ -216,13 +228,24 @@
           break;
       }
       target.effect('highlight');
+      if (element.data('scroll-to')) {
+        target[0].scrollIntoView(true);
+      }
     }
     return false;
   }
 
   function ujsAjaxError(evt, xhr, status, error) {
     alert(error || 'An error occurred.');
-    hideThrobber(this);
+    var element = $(this);
+    if (element.data('real-element')) {
+      element = $('#' + element.data('real-element'));
+    }
+    var disableElement = element;
+    if (element.is('form') &&
+        $(ujsSubmitElement).parents('form').index(element) >= 0)
+      disableElement = ujsSubmitElement;
+    hideThrobber(disableElement);
   }
 
   function ujsConfirmClick() {

data/app/assets/stylesheets/jqr-helpers.css

@@ -22,4 +22,15 @@
 
 form.ujs-ajax {
     display: inline;
-}
+}
+
+#ujs-dialog-throbber {
+    background-image: url('/images/jqr-helpers/throbber_large.gif');
+    position: fixed;
+    top: 48%;
+    left: 48%;
+    z-index: 200;
+    width: 48px;
+    height: 48px;
+}
+

data/doc/JqrHelpers/Generators/InstallGenerator.html

@@ -201,7 +201,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue Dec 31 12:22:37 2013 by
+  Generated on Fri Jan  3 15:22:08 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-1.9.3).
 </div>

data/doc/JqrHelpers/Generators.html

@@ -106,7 +106,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue Dec 31 12:22:36 2013 by
+  Generated on Fri Jan  3 15:22:08 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-1.9.3).
 </div>

data/doc/JqrHelpers/Helpers/PanelRenderer.html

@@ -452,7 +452,7 @@ be passed as is into the HTML &lt;li&gt; tag.</p>
 </div>
 
     <div id="footer">
-  Generated on Tue Dec 31 12:22:36 2013 by
+  Generated on Fri Jan  3 15:22:08 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-1.9.3).
 </div>

data/doc/JqrHelpers/Helpers.html

@@ -431,6 +431,30 @@ using content already on the page.</p>
 <p>Print a tab container.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#will_paginate_ajax-instance_method" title="#will_paginate_ajax (instance method)">- (String) <strong>will_paginate_ajax</strong>(collection, to_update, options = {}) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Create a will_paginate pagination interface which runs via Ajax.</p>
+</div></span>
+  
 </li>
 
       
@@ -482,12 +506,12 @@ using content already on the page.</p>
       <pre class="lines">
 
 
-311
-312
-313</pre>
+313
+314
+315</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 311</span>
+      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 313</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__random_string'>_random_string</span>
   <span class='const'>SecureRandom</span><span class='period'>.</span><span class='id identifier rubyid_hex'>hex</span><span class='lparen'>(</span><span class='int'>16</span><span class='rparen'>)</span>
@@ -597,8 +621,6 @@ button_to, so it can be used inside forms.</p>
       <pre class="lines">
 
 
-186
-187
 188
 189
 190
@@ -610,10 +632,12 @@ button_to, so it can be used inside forms.</p>
 196
 197
 198
-199</pre>
+199
+200
+201</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 186</span>
+      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 188</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_button_to_ajax'>button_to_ajax</span><span class='lparen'>(</span><span class='id identifier rubyid_body'>body</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
 
@@ -876,14 +900,14 @@ using content already on the page.</p>
       <pre class="lines">
 
 
-153
-154
 155
 156
-157</pre>
+157
+158
+159</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 153</span>
+      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 155</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_button_to_remote_dialog'>button_to_remote_dialog</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_html_content'>html_content</span><span class='comma'>,</span> <span class='id identifier rubyid_dialog_options'>dialog_options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span>
   <span class='id identifier rubyid_html_options'>html_options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
@@ -994,18 +1018,18 @@ then be passed into jQuery's buttonset() method.</p>
       <pre class="lines">
 
 
-299
-300
 301
 302
 303
 304
 305
 306
-307</pre>
+307
+308
+309</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 299</span>
+      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 301</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_buttonset'>buttonset</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_values'>values</span><span class='comma'>,</span> <span class='id identifier rubyid_selected'>selected</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_html_options'>html_options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_html_options'>html_options</span><span class='lbracket'>[</span><span class='symbol'>:class</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span>
@@ -1256,18 +1280,18 @@ the date and the jQuery date format to be the same.</p>
       <pre class="lines">
 
 
-282
-283
 284
 285
 286
 287
 288
 289
-290</pre>
+290
+291
+292</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 282</span>
+      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 284</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_date_picker_tag'>date_picker_tag</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>=</span><span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_today'>today</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_html_options'>html_options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_format'>format</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:format</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>%Y-%m-%d</span><span class='tstring_end'>'</span></span>
@@ -1351,8 +1375,6 @@ form_for instead of form_tag.</p>
       <pre class="lines">
 
 
-222
-223
 224
 225
 226
@@ -1361,10 +1383,12 @@ form_for instead of form_tag.</p>
 229
 230
 231
-232</pre>
+232
+233
+234</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 222</span>
+      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 224</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_form_for_ajax'>form_for_ajax</span><span class='lparen'>(</span><span class='id identifier rubyid_record'>record</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:remote</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>true</span>
@@ -1460,8 +1484,6 @@ form_tag with :remote =&gt; true.</p>
       <pre class="lines">
 
 
-206
-207
 208
 209
 210
@@ -1469,10 +1491,12 @@ form_tag with :remote =&gt; true.</p>
 212
 213
 214
-215</pre>
+215
+216
+217</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 206</span>
+      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 208</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_form_tag_ajax'>form_tag_ajax</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
 
@@ -1585,8 +1609,6 @@ used for the body.</p>
       <pre class="lines">
 
 
-167
-168
 169
 170
 171
@@ -1596,10 +1618,12 @@ used for the body.</p>
 175
 176
 177
-178</pre>
+178
+179
+180</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 167</span>
+      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 169</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_link_to_ajax'>link_to_ajax</span><span class='lparen'>(</span><span class='id identifier rubyid_body'>body</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
   <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
@@ -1946,7 +1970,9 @@ pass :div, :span, etc.</p>
 141
 142
 143
-144</pre>
+144
+145
+146</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 132</span>
@@ -1959,6 +1985,8 @@ pass :div, :span, etc.</p>
     <span class='id identifier rubyid_dialog_options'>dialog_options</span> <span class='op'>=</span> <span class='id identifier rubyid_html_content'>html_content</span>
     <span class='id identifier rubyid_html_content'>html_content</span> <span class='op'>=</span> <span class='id identifier rubyid_capture'>capture</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
   <span class='kw'>end</span>
+  <span class='id identifier rubyid_html_options'>html_options</span><span class='lbracket'>[</span><span class='symbol'>:data-throbber</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span>
+    <span class='id identifier rubyid_dialog_options'>dialog_options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:throbber</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>large</span><span class='tstring_end'>'</span></span>
 
   <span class='id identifier rubyid_html_options'>html_options</span><span class='lbracket'>[</span><span class='symbol'>:data-dialog-url</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_url'>url</span>
   <span class='id identifier rubyid_link_to_dialog'>link_to_dialog</span><span class='lparen'>(</span><span class='const'>Helpers</span><span class='period'>.</span><span class='id identifier rubyid__random_string'>_random_string</span><span class='comma'>,</span> <span class='id identifier rubyid_html_content'>html_content</span><span class='comma'>,</span>
@@ -2050,8 +2078,6 @@ URL).</p>
       <pre class="lines">
 
 
-247
-248
 249
 250
 251
@@ -2074,10 +2100,12 @@ URL).</p>
 268
 269
 270
-271</pre>
+271
+272
+273</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 247</span>
+      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 249</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_tab_container'>tab_container</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_html_options'>html_options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_renderer'>renderer</span> <span class='op'>=</span> <span class='const'>PanelRenderer</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
@@ -2107,6 +2135,137 @@ URL).</p>
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="will_paginate_ajax-instance_method">
+  
+    - (<tt>String</tt>) <strong>will_paginate_ajax</strong>(collection, to_update, options = {}) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Create a will_paginate pagination interface which runs via Ajax.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>collection</span>
+      
+      
+        <span class='type'>(<tt>Array|ActiveRecord::Relation</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the will_paginate collection.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>to_update</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the selector to use to update the content - either a “.class” or “#id”
+selector.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>options</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>options passed through to will_paginate</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+383
+384
+385
+386
+387
+388
+389
+390
+391
+392
+393
+394
+395
+396</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/jqr-helpers/helpers.rb', line 383</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_will_paginate_ajax'>will_paginate_ajax</span><span class='lparen'>(</span><span class='id identifier rubyid_collection'>collection</span><span class='comma'>,</span> <span class='id identifier rubyid_to_update'>to_update</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='kw'>if</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='const'>AjaxLinkRenderer</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:data-type</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>html</span><span class='tstring_end'>'</span></span>
+    <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:data-result-method</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>update</span><span class='tstring_end'>'</span></span>
+    <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:data-selector</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_to_update'>to_update</span>
+    <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:data-remote</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>true</span>
+    <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:data-scroll-to</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>true</span>
+    <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:data-throbber</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:throbber</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>large</span><span class='tstring_end'>'</span></span>
+    <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:renderer</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>AjaxLinkRenderer</span>
+    <span class='id identifier rubyid_will_paginate'>will_paginate</span><span class='lparen'>(</span><span class='id identifier rubyid_collection'>collection</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+  <span class='kw'>else</span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>will_paginate not installed!</span><span class='tstring_end'>'</span></span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
   </div>
@@ -2114,7 +2273,7 @@ URL).</p>
 </div>
 
     <div id="footer">
-  Generated on Tue Dec 31 12:22:36 2013 by
+  Generated on Fri Jan  3 15:22:08 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-1.9.3).
 </div>

data/doc/JqrHelpers/Rails.html

@@ -92,7 +92,7 @@
         <dt id="VERSION-constant" class="">VERSION =
           
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>1.0.18</span><span class='tstring_end'>'</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>1.0.19</span><span class='tstring_end'>'</span></span></pre></dd>
       
     </dl>
   
@@ -108,7 +108,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue Dec 31 12:22:36 2013 by
+  Generated on Fri Jan  3 15:22:08 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-1.9.3).
 </div>

data/doc/JqrHelpers/Railtie.html

@@ -114,7 +114,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue Dec 31 12:22:36 2013 by
+  Generated on Fri Jan  3 15:22:08 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-1.9.3).
 </div>

data/doc/JqrHelpers.html

@@ -110,7 +110,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue Dec 31 12:22:36 2013 by
+  Generated on Fri Jan  3 15:22:08 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-1.9.3).
 </div>

data/doc/_index.html

@@ -174,7 +174,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue Dec 31 12:22:36 2013 by
+  Generated on Fri Jan  3 15:22:08 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-1.9.3).
 </div>

data/doc/index.html

@@ -174,7 +174,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue Dec 31 12:22:36 2013 by
+  Generated on Fri Jan  3 15:22:08 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-1.9.3).
 </div>

data/doc/method_list.html

@@ -149,6 +149,12 @@
   </li>
   
 
+  <li class="r2 ">
+    <span class='object_link'><a href="JqrHelpers/Helpers.html#will_paginate_ajax-instance_method" title="JqrHelpers::Helpers#will_paginate_ajax (method)">#will_paginate_ajax</a></span>
+    <small>JqrHelpers::Helpers</small>
+  </li>
+  
+
       </ul>
     </div>
   </body>

data/doc/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue Dec 31 12:22:36 2013 by
+  Generated on Fri Jan  3 15:22:08 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-1.9.3).
 </div>

data/jqr-helpers.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name         = 'jqr-helpers'
   s.require_paths = %w(. lib lib/jqr-helpers)
-  s.version      = '1.0.18'
-  s.date         = '2013-12-31'
+  s.version      = '1.0.19'
+  s.date         = '2014-01-03'
   s.summary      = 'Helpers to print unobtrusive jQuery-UI tags.'
   s.description  = <<-EOF
     This gem adds helper methods to create unobtrusive jQuery code. It outputs
@@ -15,6 +15,7 @@ EOF
   s.files        = `git ls-files`.split($/)
   s.homepage     = 'https://github.com/wishabi/jqr-helpers'
   s.license       = 'MIT'
+  s.requirements  << 'Optionally install will_paginate to allow Ajax pagination'
 
   s.add_dependency 'rails', '>= 3.0'
   s.add_development_dependency 'yard'

data/lib/jqr-helpers/helpers.rb

@@ -137,6 +137,8 @@ module JqrHelpers
         dialog_options = html_content
         html_content = capture(&block)
       end
+      html_options[:'data-throbber'] =
+        dialog_options.delete(:throbber) || 'large'
 
       html_options[:'data-dialog-url'] = url
       link_to_dialog(Helpers._random_string, html_content,
@@ -312,6 +314,89 @@ module JqrHelpers
       SecureRandom.hex(16)
     end
 
+    # Only run this code if will_paginate is installed
+    begin
+      require 'will_paginate/view_helpers'
+      require 'will_paginate/view_helpers/action_view'
+
+      # Define a link renderer to use with will_paginate.
+      class AjaxLinkRenderer < WillPaginate::ActionView::LinkRenderer
+
+        # Returns the subset of +options+ this instance was initialized with
+        # that represent HTML attributes for the container element of pagination
+        # links.
+        def container_attributes
+          @container_attributes ||=
+           @options.except(*(WillPaginate::ViewHelpers.pagination_options.keys +
+              _ajax_keys + [:renderer] - [:class]))
+        end
+
+        protected
+
+        def page_number(page)
+          ajax_options = @options.slice(*_ajax_keys)
+          if page == current_page
+            tag(:em, page, :class => 'current')
+          else
+            link(page, page,
+              ajax_options.merge(:class => 'ujs-ajax', :rel => rel_value(page)))
+          end
+        end
+
+        def previous_or_next_page(page, text, classname)
+          ajax_options = @options.slice(*_ajax_keys)
+          if page
+            link(text, page,
+                 ajax_options.merge(:class => "#{classname} ujs-ajax"))
+          else
+            tag(:span, text,
+                ajax_options.merge(:class => "#{classname} disabled"))
+          end
+        end
+
+        private
+
+        # Option keys used exclusively for jqr-helpers Ajax stuff.
+        # @return [Array<Symbol>]
+        def _ajax_keys
+          [
+            :'data-type',
+            :'data-result-method',
+            :'data-selector',
+            :'data-remote',
+            :'data-scroll-to',
+            :'data-throbber'
+          ]
+        end
+
+      end
+    rescue # no will_paginate installed
+    end
+
+    # Create a will_paginate pagination interface which runs via Ajax. If
+    # will_paginate is not in the Gemfile or gem environment, this will
+    # throw an error.
+    # @param collection [Array|ActiveRecord::Relation] the
+    #     will_paginate collection.
+    # @param to_update [String] the selector to use to update the content -
+    #   either a ".class" or "#id" selector.
+    # @param options [Hash] options passed through to will_paginate
+    # @return [String]
+    def will_paginate_ajax(collection, to_update, options={})
+      if defined?(AjaxLinkRenderer)
+        options[:'data-type'] = 'html'
+        options[:'data-result-method'] = 'update'
+        options[:'data-selector'] = to_update
+        options[:'data-remote'] = true
+        options[:'data-scroll-to'] = true
+        options[:'data-throbber'] = options[:throbber] || 'large'
+        options[:renderer] = AjaxLinkRenderer
+        will_paginate(collection, options)
+      else
+        raise 'will_paginate not installed!'
+      end
+    end
+
     private
 
     # @param format [String] the Rails date format to map
@@ -368,6 +453,8 @@ module JqrHelpers
       new_options[:'data-close-dialog'] = options.delete(:close_dialog)
       new_options[:'data-use-dialog-opener'] = options.delete(:use_dialog_opener)
       new_options[:'data-refresh'] = true if options.delete(:refresh)
+      new_options[:'data-scroll-to'] = true if options.delete(:scroll_to)
+      new_options[:'data-throbber'] = options.delete(:throbber) || 'small'
 
       [:update, :append, :delete].each do |result_method|
         selector = options.delete(result_method)

data/lib/jqr-helpers/version.rb

@@ -1,5 +1,5 @@
 module JqrHelpers
   module Rails
-    VERSION = '1.0.18'
+    VERSION = '1.0.19'
   end
 end

metadata

@@ -2,14 +2,14 @@
 name: jqr-helpers
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 1.0.18
+  version: 1.0.19
 platform: ruby
 authors:
 - Daniel Orner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-31 00:00:00.000000000 Z
+date: 2014-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -56,6 +56,7 @@ files:
 - Readme.md
 - app/assets/images/jqr-helpers/close.png
 - app/assets/images/jqr-helpers/throbber.gif
+- app/assets/images/jqr-helpers/throbber_large.gif
 - app/assets/javascripts/jqr-helpers.js
 - app/assets/stylesheets/jqr-helpers.css
 - doc/JqrHelpers.html
@@ -105,7 +106,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- Optionally install will_paginate to allow Ajax pagination
 rubyforge_project: 
 rubygems_version: 1.8.25
 signing_key: