Skip to content
Pagination library for Rails, Sinatra, Merb, DataMapper, and more
Ruby Shell Roff
Branch: master
Clone or download

Latest commit

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib will_paginate 3.3.0 Feb 26, 2020
script Fix `script/release` so that `gem push` works with OTP Feb 26, 2020
spec Upgrade rspec Feb 25, 2020
.gitignore Update Brewfile Feb 19, 2020
.rspec setup continuous integration testing with Travis-CI Jul 28, 2011
.travis.yml Drop Ruby 1.9 compatibility Feb 25, 2020
Brewfile Update Brewfile Feb 19, 2020
CONTRIBUTING.md Add CONTRIBUTING.md Feb 26, 2020
Gemfile Remove special Gemfile section for Ruby 1.9 Feb 25, 2020
Gemfile.rails-edge Remove special Gemfile section for Ruby 1.9 Feb 25, 2020
Gemfile.rails3.0 Remove special Gemfile section for Ruby 1.9 Feb 25, 2020
Gemfile.rails3.1 Remove special Gemfile section for Ruby 1.9 Feb 25, 2020
Gemfile.rails3.2 Remove special Gemfile section for Ruby 1.9 Feb 25, 2020
Gemfile.rails4.0 Remove special Gemfile section for Ruby 1.9 Feb 25, 2020
Gemfile.rails4.1 Remove special Gemfile section for Ruby 1.9 Feb 25, 2020
Gemfile.rails4.2 Remove special Gemfile section for Ruby 1.9 Feb 25, 2020
Gemfile.rails5.0 Remove special Gemfile section for Ruby 1.9 Feb 25, 2020
Gemfile.rails5.1 Remove special Gemfile section for Ruby 1.9 Feb 25, 2020
Gemfile.rails5.2 Remove special Gemfile section for Ruby 1.9 Feb 25, 2020
LICENSE Total rdoc love. Point out that this is framework-agnostic now Jan 12, 2009
README.md Merge pull request #544 from phoffer/hanami Oct 9, 2019
init.rb mix in Active Record/Action View directly on `require` Aug 5, 2011
will_paginate.gemspec Drop Ruby 1.9 compatibility Feb 25, 2020

README.md

will_paginate

will_paginate is a pagination library that integrates with Ruby on Rails, Sinatra, Hanami::View, Merb, DataMapper and Sequel.

Installation:

## Gemfile for Rails 3+, Sinatra, and Merb
gem 'will_paginate', '~> 3.1.0'

See installation instructions on the wiki for more info.

Basic will_paginate use

## perform a paginated query:
@posts = Post.paginate(page: params[:page])

# or, use an explicit "per page" limit:
Post.paginate(page: params[:page], per_page: 30)

## render page links in the view:
<%= will_paginate @posts %>

And that's it! You're done. You just need to add some CSS styles to make those pagination links prettier.

You can customize the default "per_page" value:

# for the Post model
class Post
  self.per_page = 10
end

# set per_page globally
WillPaginate.per_page = 10

New in Active Record 3:

# paginate in Active Record now returns a Relation
Post.where(:published => true).paginate(:page => params[:page]).order('id DESC')

# the new, shorter page() method
Post.page(params[:page]).order('created_at DESC')

See the wiki for more documentation. Report bugs on GitHub.

Happy paginating.

You can’t perform that action at this time.