Updated for will_paginate 2.3.x
So you’re using the will_paginate plugin and want to use remote AJAX links. You’re not using the will_paginate plugin? Simply install it with…
or install the gem and specify it in your config/environment.rb file
will_paginate is an alternative to the classic_pagination plugin, which is the pagination plugin that basically took the pre Rails 2.0 pagination implementation and packaged it in plugin form. I won’t discuss the differences between the two plugins here, but there’s a good video explaining the two from Railscasts [here](http://railscasts.com/episodes/51).
Out of the box, will_paginate doesn’t allow remote AJAX links for page links, so I’ll show you an easy way to add such functionality…
I’ve read a number of blogs that seem to go a bit overboard in order to implement remote links, but will_paginate allows you to customize the links quite nicely already.
By default will_paginate uses the
WillPaginate::LinkRender class to render links. So lets use this is a base and add to it. We can derive from this class and add our own functionality.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
All I’m doing is creating a subclass to the existing renderer and overriding the
page_link_or_span method that makes the link_to method call and replacing it with a call to link_to_remote (I also added the
:method => :get option to work with my restful code).
So how do we use this? One of two ways.
- Use the
:remote(optional) option on will_paginate. The
:remoteoption takes any options that
link_to_remotedoes, so refer to the rails docs for allowable options. The :with and :update options are simply being used to show example usage.
- or set the default renderer in
- and use it without the
That’s all there is to it. You could get fancier when creating your LinkRenderer class to allow for additional customization, but this is a good start.
Update for will_paginate 2.3.x
This is even more concise in the new version.
1 2 3 4 5 6 7 8 9 10 11 12 13
The usage remains the same as above.
To use the new version, see the Installation section at http://github.com/mislav/will_paginate/tree/master