UK Specialists in Ruby on Rails, Exalead, AWS, Consultancy - Roll your own pagination links with will_paginate Comments

Comment on 'Roll your own pagination links with will_paginate' by Rob Anderton

2011-09-15T17:11:14Z

@SaveTimE: using the pagination in your edit action should be no problem, call paginate on whatever the collection is your paginating and pass the result to the helper in the view, just as you would in an index action (without seeing an example of code it's hard to be more specific!).

It should also pick up the edit URL and just append a page number to it, so you'll get the ID just as you would with a normal edit URL. If you need to customise you can also pass the helper the :params option with things like :controller and :action.

Comment on 'Roll your own pagination links with will_paginate' by Rob Anderton

2011-09-15T16:49:30Z

@mahhek - sorry I didn't see this sooner, you've probably fixed it by now, but here goes anyway!

The answer you got on stackoverflow is close to what you need. I think you're getting an error because the page_link_or_span method expects two parameters, so the call should be something like:

def windowed_links
  prev = nil

  visible_page_numbers.inject [] do |links, n|
    links << gap_marker if prev and n > prev + 1
    links << page_link_or_span(n, (n == current_page ? 'current' : nil))
    prev = n
    links
  end
end

You should also make sure the gap_marker method is returning a list item so it doesn't mess up the HTML list:

def gap_marker
  "<li>...</li>"
end

Comment on 'Roll your own pagination links with will_paginate' by SaveTimE

2011-09-15T13:22:22Z

Hi Rob, I need to use pagination in the edit view. I checked out your list renderer and it works perfect(thanks for that work), but how can I define that it is only used by a specific controller and where and how do I implement and pass the ID?

Comment on 'Roll your own pagination links with will_paginate' by mahhek

2011-06-26T21:15:54Z

I am looking for the answer for this question :$

http://stackoverflow.com/questions/3007429/will-paginate-how-to-add-a-separator-between-the-inner-window-and-outer-window

Comment on 'Roll your own pagination links with will_paginate' by Rob Anderton

2010-11-13T23:01:48Z

It should be a similar solution: add a form to your page which allows the :page param to be set and add a little bit of typecasting in the controller to handle dodgy input. For example:

# in the view
<% form_tag({}, { :method => :get }) do %>
  <%= text_field_tag("page", @collection.current_page) %>
  <%= submit_tag("Go", :name => nil) %>
<% end %>

# in the controller
page = params[:page].to_i < 1 ? 1 : params[:page]
@collection = Model.paginate(:page => page)

Comment on 'Roll your own pagination links with will_paginate' by Naveenkumar.R

2010-10-23T13:50:35Z

Hi,

I need to customize the will paginate like "Pagination With Manual Page Input" For example: The user can enter the page number in input box rather than selection box. on press enter it should paginate to particular page.And also the input box should show the current page selected.

Is it possible in will_paginate

Comment on 'Roll your own pagination links with will_paginate' by Rob Anderton

2010-08-22T22:46:35Z

hi shriya,
It could be that you need to check the page numbers are valid, for example if you're on page 3 your current code will generate a link to page -2. I've not tried this but it might work:

module WillPaginate
  class PaginationListLinkRenderer < LinkRenderer
    def to_html
       links = []
       links << page_link_or_span(1, 'first_page', 1)
       links << page_link_or_span(@collection.current_page - 5, 'prev5_page', "<<prev5") if @collection.current_page - 5 > 0
       links << page_link_or_span(@collection.previous_page, 'prev_page', "<<prev")
       links << page_link_or_span(@collection.current_page, 'current', @collection.current_page)
       links << page_link_or_span(@collection.next_page, 'next_page', "next>>")
       links << page_link_or_span(@collection.current_page + 5, 'next5_page', "next5>>") unless @collection.current_page + 5 > @collection.total_pages
       links << page_link_or_span(@collection.total_pages, 'last_page', @collection.total_pages)

       html = links.join(@options[:separator])
       html = html.html_safe if html.respond_to? :html_safe
       @options[:container] ? @template.content_tag(:div, html, html_attributes) : html
    end
  end
end

You might also notice you don't need to pass the 'disabled' style, that was a mistake in my earlier example which I'll fix. If this still raises an error post the error message you're getting and I'll take another look.

Rob

Comment on 'Roll your own pagination links with will_paginate' by shriya

2010-08-18T10:05:57Z

i have posted the correct code in pastie and url is http://pastie.org/1099607

Comment on 'Roll your own pagination links with will_paginate' by shriya

2010-08-18T09:55:58Z

sorry pagination page must look like

1 <<prev5><prev>> next5>> 50

1 means first page 50 means last page

Comment on 'Roll your own pagination links with will_paginate' by shriya

2010-08-18T09:51:55Z

nice article Rob,
i want the pagination to look like this
1 <<prev5 <<prev 6 next>> next5>> 50

so i customized the code somewhat like below in PaginationListLinkRenderer

def to_html
  links = []
  links.unshift page_link_or_span(1, 'disabled first_page', 1)
  links.push  page_link_or_span(@collection.previous_page - 4, 'disabled prev5_page', @options[:previous])
  links.push  page_link_or_span(@collection.previous_page, 'disabled prev_page', @options[:previous_label])
  links.push page_link_or_span(@collection.current_page, 'current')
  links.push page_link_or_span(@collection.next_page, 'disabled next_page', @options[:next_label])
  links.push page_link_or_span(@collection.next_page + 4, 'disabled next5_page', @options[:next])
  links.push    page_link_or_span(@collection.total_pages,     'disabled last_page', @collection.total_pages)
  html = links.join(@options[:separator])
  html = html.html_safe if html.respond_to? :html_safe
  @options[:container] ? @template.content_tag(:div, html, html_attributes) : html
end

it is throwing error when i click on first page and last page link can u help me

Comment on 'Roll your own pagination links with will_paginate' by Rob Anderton

2010-08-16T16:53:47Z

Yep coming to a blog near you very soon!

Comment on 'Roll your own pagination links with will_paginate' by Cyrille

2010-08-16T08:45:37Z

Hi Rob, great article. Any plan for an update for will_paginate 3 and rails 3 ?

Thanks

Comment on 'Roll your own pagination links with will_paginate' by sharath

2010-08-09T14:36:26Z

Thank you Rob:) Thanks for this Fantastic article!!!!!!!.

Comment on 'Roll your own pagination links with will_paginate' by Rob Anderton

2010-08-06T23:04:36Z

Add a form to your page and when it's submitted, pass the value to the paginate method in the controller, for example:

# in the view
<% form_tag({}, { :method => :get }) do %>
  <%= select_tag("per_page", options_for_select([ [ "24 per page", 24 ], [ "48 per page", 48 ], [ "96 per page", 96 ] ], @per_page)) %>
  <%= submit_tag("Go", :name => nil) %>
<% end %>

# in the controller
@per_page = params[:per_page].blank? ? 24 : params[:per_page].to_i
@collection = Model.paginate(:page => params[:page], :per_page => @per_page)

Comment on 'Roll your own pagination links with will_paginate' by sharath

2010-08-05T14:42:14Z

ya "Pagination With Manual Page Input" i wanted 2 item that have option like selecting 24 per pages or 48 per pages,or 96 per pages like that taking input from user for how many pages must be there per pages

Comment on 'Roll your own pagination links with will_paginate' by Rob Anderton

2010-08-05T13:28:07Z

Which bit of the article do you mean? The "Pagination With Manual Page Input" section, or something else?

Comment on 'Roll your own pagination links with will_paginate' by sharath

2010-08-05T09:59:59Z

thanks for your answer Rob i want to give manually input for pagination ,allowing users to select how many pages they want to be display as shown in this website

http://www.smashingmagazine.com/2007/11/16/pagination-gallery-examples-and-good-practices/

can i achieve it using will paginate

Comment on 'Roll your own pagination links with will_paginate' by Rob Anderton

2010-08-04T21:53:27Z

My first thought was to use the default link renderer with :inner_window and :outer_window options set to zero but because of the way it calculates the visible pages this doesn't work.

Instead you'll need to define a custom link renderer and, like in comment 21, just override the to_html method to do something like this:

def to_html
  html = [
    page_link_or_span(@collection.previous_page, 'prev_page', @options[:previous_label]),
    page_link_or_span(@collection.current_page, 'current'),
    page_link_or_span(@collection.next_page, 'next_page', @options[:next_label])
  ].join(@options[:separator])

  html = html.html_safe if html.respond_to? :html_safe
  @options[:container] ? @template.content_tag(:div, html, html_attributes) : html
end

Comment on 'Roll your own pagination links with will_paginate' by sharath

2010-08-04T12:40:04Z

hi Rob

i want to display only previous , next and current page no how can i do it

Comment on 'Roll your own pagination links with will_paginate' by Rob Anderton

2010-08-03T09:57:57Z

@nirmal: if you post the relevant code (as a pastie or a gist) I'll take a look, at the moment it's hard to figure out exactly what you're doing :)

@diego: the API has changed a lot for version 3 causing breakage of code like my custom renderer. I'll have to get around to doing a new post about it, but until then take a look at the new WillPaginate::ViewHelpers::LinkRenderer source as it doesn't look as if it'll be too hard to modify my code to work with this new version.

Comment on 'Roll your own pagination links with will_paginate' by Diego Plentz

2010-07-29T15:02:49Z

Rob,

I'm using will_paginate 3.0.pre2 with rails 3.0.0.rc, but even if I put the PaginationListLinkRenderer class inside RAILS_ROOT/lib, then I visit my page that has pagination, I receive the following error:

ActionView::Template::Error (uninitialized constant PaginationListLinkRenderer):

You know anything I can do to try fix this?

Thanks in advance

ps: btw, if I put PaginationListLinkRenderer inside RAILS_ROOT/app/helpers, the error change to: "ActionView::Template::Error (uninitialized constant WillPaginate::LinkRenderer)"

Comment on 'Roll your own pagination links with will_paginate' by nirmal

2010-07-23T08:32:15Z

iam using two different images in pagination i.e. one for pagelinks and another for (previous_label and next_label)

but i could only see image used for pagelinks in the placae of image for(prev and next labels)

so it displays same image for both pagelinks and (prev and next labels).

how can i display two different images i.e. one image for pagelinks and another image for (prev and next labels)

Comment on 'Roll your own pagination links with will_paginate' by Kent Fenwick

2010-06-23T20:50:27Z

Thank you for this! Fantastic article.

Comment on 'Roll your own pagination links with will_paginate' by Rob Anderton

2010-06-17T11:10:53Z

@irishman_irl: if you're using the default link renderer then it should already be doing this, if you're using the PaginationListLinkRenderer from this post then you need to change the windowed_links method to work more like the default renderer and also define a new constructor to initialize the @gap_marker instance variable to use a list item instead of the default span.

@Jose: if you're using the PaginationListLinkRenderer from this blog then you can change the windowed_links method to do what you need:

def windowed_links
  visible_page_numbers.map { |n| page_link_or_span(n, (n == current_page ? 'number current' : 'current')) }
end

If you're using the default link renderer then you need to override the windowed_links method in your subclass and change this line:

links << page_link_or_span(n, 'current')

to this:

links << page_link_or_span(n, 'current number')

And will_paginate should take care of the rest.

Comment on 'Roll your own pagination links with will_paginate' by Goyox86

2010-06-09T21:03:36Z

Oops! , The "number current", is the class for the current page.

Jose

Comment on 'Roll your own pagination links with will_paginate' by Goyox86

2010-06-09T21:02:26Z

Hi People,

The graphic designer who is working with me, has customized the look of the pagination links with two CSS classes, "number" for all the pages number links, and "number current". this post is excellent, but i'm pretty messy on how i can achieve this?, I've sub-classed WillPaginate::LinkRenderer, and created a initializer but, i don't know how to apply the css classes, to the generated markup.

Thx in advance! Jose

Comment on 'Roll your own pagination links with will_paginate' by irishman_irl

2010-06-09T15:39:52Z

Fantastic tutorial, really helped me out in work to quickly solve a problem.

One issue I have though, there are 70 pages to be paginated, I have set the :inner_window=>2 and :outer_window=>2 and the pagination produces:

1 2 3 4 5 65 66 67

How can I add a "..." seperator between 5 and 65 in the page numbers?

Comment on 'Roll your own pagination links with will_paginate' by Tony Maserati

2010-06-07T10:59:02Z

Much obliged!

Comment on 'Roll your own pagination links with will_paginate' by Rob Anderton

2010-06-01T21:31:23Z

You can create your own subclass of the default link renderer and override the to_html method like this:

class CustomLinkRenderer < WillPaginate::LinkRenderer

  def to_html
    links = @options[:page_links] ? windowed_links : []
    # previous/next buttons
    links.push(page_link_or_span(@collection.previous_page, 'prev_page', @options[:previous_label]))
    links.push(page_link_or_span(@collection.next_page, 'next_page', @options[:next_label]))

    html = links.join(@options[:separator])
    html = html.html_safe if html.respond_to?(:html_safe)
    @options[:container] ? @template.content_tag(:div, html, html_attributes) : html
  end

end

The only change here is that the previous link is being pushed onto the end of the links array rather than being added to the start of the array.

Comment on 'Roll your own pagination links with will_paginate' by Tony Maserati

2010-06-01T14:12:05Z

Anybody know how to make it "1 2 3 Previous Next" as opposed to "Previous 1 2 3 Next"? Thank you.

Comment on 'Roll your own pagination links with will_paginate' by Pedro Teixeira

2010-04-13T14:25:39Z

Thanks a lot for the the instructions on making your own will_paginate custom renderer!

Comment on 'Roll your own pagination links with will_paginate' by Rob Anderton

2010-03-27T19:33:33Z

@Bram: not sure what your rails/will_paginate versions are but you could try forcing the correct class name by prefixing it with ::, for example:

WillPaginate::ViewHelpers.pagination_options[:renderer] = '::PaginationListLinkRenderer'

If that doesn't help post the relevant code (as a pastie or a gist) and I'll take a look.

Rob

Comment on 'Roll your own pagination links with will_paginate' by Bram

2010-03-26T15:15:09Z

uninitialized constant ActionView::Base::CompiledTemplates::PaginationListLinkRenderer

Comment on 'Roll your own pagination links with will_paginate' by Bram

2010-03-26T15:14:32Z

Can't get the custom renderer to initialize, any help? I'll be googling in the meantime. Nice tutorial, this info should be in de will_paginate docs.

Comment on 'Roll your own pagination links with will_paginate' by Rob Anderton

2010-01-13T10:57:21Z

If you post the code you have so far (either as a pastie or a gist) I'd be happy to take a look at what you're missing.

Comment on 'Roll your own pagination links with will_paginate' by Volkan Caliskan

2010-01-11T20:01:20Z

<div class="pager bottompager">
 <a href="" class="first"></a>
 <a href="" class="previous"><img src="images/prev.gif" alt="" /> Previous</a>
 <div class="pages">
  <a href="" class="current">1</a>
  <a href="">2</a>
  <a href="">3</a>
 </div>
 <a href="" class="next">Next <img src="images/next.gif" alt="" /></a>
 <a href="" class="last"></a>
</div>

Very professional tutorial, thank you. I figured out most of the things but still can't get this exact view. Any ideas would be highly appreciated!

Comment on 'Roll your own pagination links with will_paginate' by James

2009-10-06T19:25:04Z

Thanks guys, this was very useful! :)

Comment on 'Roll your own pagination links with will_paginate' by yufang

2009-05-20T05:28:43Z

I want to use will_paginate with ajax ,But how do i do it?

Comment on 'Roll your own pagination links with will_paginate' by Rob Anderton

2009-05-10T15:55:07Z

@vatsav: to turn off page links without needing to do any custom coding, you can set the page_links option to false in an initializer:

WillPaginate::ViewHelpers.pagination_options[:page_links] = false

To get the first and last page links, you'll need to write your own custom link renderer, and do something like this in the to_html method:

links.unshift(page_link_or_span(1, 'first', 'First'))
    links.push(page_link_or_span(@collection.total_pages, 'last', 'Last'))

Rob

Comment on 'Roll your own pagination links with will_paginate' by vatsav

2009-04-29T14:06:41Z

i dont want the page numbers to be displayed along with previous and next. and I want first and last pages instead og numbers. can anybody please tell me how to do that?

Comment on 'Roll your own pagination links with will_paginate' by Rob Anderton

2009-03-30T07:45:51Z

I usually put the link renderer in my lib folder, for example in RAILS_ROOT/lib/pagination_list_link_renderer.rb. I then create a plugins initializer in RAILS_ROOT/config/initializers/plugins.rb that contains the WillPaginate configuration:

WillPaginate::ViewHelpers.pagination_options[:renderer] = 'PaginationListLinkRenderer'

Rails will then autoload the class (so no requires required!) because it is in the lib folder.

Comment on 'Roll your own pagination links with will_paginate' by g-sal

2009-03-29T22:13:07Z

This information was very useful, thank you. Unfortunately I'm new to Ruby and Rails and was wondering where the extended class should be located in the application? Also, are there are dependencies I need to declare and where (like 'require' or something similar?)

Comment on 'Roll your own pagination links with will_paginate' by Rob Anderton

2008-10-31T08:47:28Z

Do you mean the ‘…’ and the gap in page numbers? If so, that’s the windowed links functionality of will_paginate, so that even if you had 1,000 pages to link to the pagination area wouldn't take up a huge amount of space.

You can customise the windowing behaviour using the :inner_window (the number of page links shown before and after the current page - defaults to 4) and :outer_window (the number of page links shown at the start and end of pagination - defaults to 1) settings.

To get rid of windowing altogether, you could look at overriding the visible_page_numbers method in your LinkRenderer class (this is where the windowing calculations are performed) and then replace the call to windowed_links in the to_html method to call visible_page_numbers directly.

Hope that helps!
Rob

Comment on 'Roll your own pagination links with will_paginate' by Zoran Kikic

2008-10-30T17:43:12Z

Sorry, Markdown didn't like my links..

again: http://zoran.name/paginating_find.jpg http://zoran.name/will_paginate.jpg

Comment on 'Roll your own pagination links with will_paginate' by Zoran Kikic

2008-10-30T09:35:04Z

I modified your code and adapted some css (cross browser compatible) to it which I primarily wrote for paginatingfind: (http://zoran.name/paginatingfind.jpg).

My willpaginate looks now like this: (http://zoran.name/willpaginate.jpg) - yes without gaps. What's the problem with those gaps in will_paginate? Can you please explain it a little bit?

Comment on 'Roll your own pagination links with will_paginate' by Rob Anderton

2008-10-29T22:06:32Z

Hi Zoran,
Thanks for the reminder - at the time of writing :prev_label was correct, but since then Mislav changed it to :previous_label. I've updated the code to reflect this.
Rob

Comment on 'Roll your own pagination links with will_paginate' by Zoran Kikic

2008-10-29T18:06:52Z

Hey Rob,

thanks for sharing!

Good job but there is a small bug in your class:

it must be @options[:previous_label] not @options[:prev_label]

cheers

Comment on 'Roll your own pagination links with will_paginate' by Rob Anderton

2008-08-04T07:11:51Z

Thanks for the update Mislav - I agree that there doesn’t seem to be a semantic way to represent gaps in lists of links which is why I cheated and didn’t include them in the example!

Given that you can markup pagination however you want using custom renderers there doesn’t really seem to be a need to change what will_paginate does by default, although I guess you could include a list based renderer as part of the plugin/gem for those who want it.

Comment on 'Roll your own pagination links with will_paginate' by Mislav

2008-08-03T21:52:25Z

This is a good example of using a custom link renderer, but be aware that the link renderer API could change in will_paginate 2.5. To lock the library to a specific version in your app, follow the instructions on the will_paginate wiki.

There have been feature requests for will_paginate to generate HTML lists in markup. I have given it a thought, but finally refused because of the "gaps" between page numbers (represented by "..."). I don't think those gaps can be semantically represented with lists in HTML.