Will Paginate plugin

Plugin details

will_paginate allows you to easily add pagination to your application by simply using 'model.paginate' instead of 'model.find'.

Websitehttp://github.com/mislav/will_paginate/tree/master Repositorygit://github.com/mislav/will_paginate.git Author K. Adam Christensen, Chris Wanstrath, Dr. Nic Williams Tags Pagination LicenseUnknown

Documentation

Install the plugin:
ruby script/plugin install git://github.com/mislav/will_paginate.git

Use a paginate finder in the controller:

@posts = Post.paginate_by_board_id @board.id, :page => params[:page]



Yeah, paginate works just like find -- it just doesn't fetch all the records. Just don't forget to tell it which page you want!

Render the posts in your view like you would normally do. When you need to render pagination, just stick this in:

<%= will_paginate @posts %>



You're done. (Copy and paste the example fancy CSS styles from the bottom.)

How does it know how much items to fetch per page? It asks your model by calling Post.per_page. You can define it like this:

    class Post < ActiveRecord::Base
      cattr_reader :per_page
      @@per_page = 50
    end



... or like this:

    class Post < ActiveRecord::Base
      def self.per_page
        50
      end
    end



or don't worry about it at all. (WillPaginate defines it to be 30 if missing.) You can also specify the count explicitly when calling +paginate+:

    @posts = Post.paginate :page => params[:page], :per_page => 50



The paginate finder wraps the original finder and returns your resultset that now has some new properties. You can use the collection as you would with any ActiveRecord resultset, but WillPaginate view helpers also need that object to be able to render pagination:

    
      <% for post in @posts -%>
        Render `post` in some nice way.
      <% end -%>
    

    Now let's render us some pagination!
    <%= will_paginate @posts %>

Further Documentation

There is currently no advanced documentation for this plugin.

New documentation

Edit plugin | Back in time (1 older version) | Last edited by: scott, 6 months ago