- WARNING: The
foundation,materialize,semanticanduikitCSS extras have been discontinued and will be removed in v9 (See the details) - New Pagy Playground to showcase, clone and develop pagy APPs without any setup on your side (try the pagy demo)
- New
:max_pagesvariable to limit the pagination regardless the actual count - Better frontend helpers
- See the Changelog for possible breaking changes
Each dot in the visualization above represents the resources that Pagy consumes for one full rendering. The other gems consume hundreds of times as much for the same rendering.
The IPS/Kb ratio is calculated out of speed (IPS) and Memory (Kb): it shows how well each gem uses each Kb of memory it allocates/consumes.
Notice: the above charts refers to the comparison of the basic pagy v3.0.0 helper with will_paginate v3.1.7
and kaminari v1.1.1.
While it's not up-to-date, you can expect roughly similar results with the latest versions, maybe a bit less dramatic in
performance due to the multiple features added to pagy since v3 (e.g. customizable and translated aria-labels). However, consider
that the difference become A LOT bigger in favor of pagy if you use *nav_js helpers, Pagy::Countless or JSON and client side
pagination that are not part of the comparison because missing in the other gems.
See the Detailed Gems Comparison for full details.
- It works in any environment
With Rack frameworks (Rails, Sinatra, Padrino, etc.) or in pure ruby without Rack - It works with any collection
With any ORM, any DB, any search gem, elasticsearch_rails, meilisearch, searchkick,ransack, and just about any list, even if you cannot count it - It supports all kinds of pagination
calendar, countless, geared, incremental, auto-incremental, infinite, headers, JSON, cursor - It supports the most popular CSS Frameworks and APIs
bootstrap, bulma, tailwind, JSON:API - It supports faster client-side rendering
With classic or innovative UI components (see Javascript Components) or by serving JSON to your favorite Javascript framework - It has 100% of test coverage for Ruby, HTML and Javascript E2E ( see Pagy Workflows CI)
- Pagy has a very slim core code very easy to understand and use.
- It has a quite fat set of optional extras that you can explicitly require for very efficient and modular customization ( see extras)
- It has no dependencies: it produces its own HTML, URLs, i18n with its own specialized and fast code
- Its methods are accessible and overridable right where you use them (no pesky monkey-patching needed)
- Pagy is very modular and does not load any unnecessary code ( see why...)_
- It doesn't impose limits even with collections|scopes that already used
limitandoffset( see how...) - It raises
Pagy::OverflowErrorexceptions that you can rescue from ( see how...) or use the overflow extra for a few ready to use common behaviors - It does not impose any difficult-to-override logic or output
Code for basic pagination...
# Include it in the controllers (e.g. application_controller.rb)
include Pagy::Backend
# Include it in the helpers (e.g. application_helper.rb)
include Pagy::Frontend
# Wrap your collections with pagy in your actions
@pagy, @records = pagy(Product.all)Optionally set your defaults in the pagy initializer:
# Optionally override some pagy default with your own in the pagy initializer
Pagy::DEFAULT[:items] = 10 # items per page
Pagy::DEFAULT[:size] = [1, 4, 4, 1] # nav bar links
# Better user experience handled automatically
require 'pagy/extras/overflow'
Pagy::DEFAULT[:overflow] = :last_page<%# Render a view helper in your views (skipping nav links for empty pages) %>
<%== pagy_nav(@pagy) if @pagy.pages > 1 %>Or, choose from the following view helpers:
| View Helper Name | Preview (Bootstrap Style shown) |
|---|---|
pagy_nav(@pagy) |
 |
pagy_nav_js(@pagy) |
 |
pagy_info(@pagy) |
 |
pagy_combo_nav_js(@pagy) |
 |
pagy_items_selector_js |
 |
pagy_nav(@calendar[:year])pagy_nav(@calendar[:month])(other units: :quarter, :week, :day and custom) |
 |
(See the Quick Start)
Customization for CSS frameworks...
# Require a CSS framework extra in the pagy initializer (e.g. bootstrap)
require 'pagy/extras/bootstrap'<%# Use it in your views %>
<%== pagy_bootstrap_nav(@pagy) %>(See all the CSS Framework Extras)
Customization for special collections...
# Require some special backend extra in the pagy initializer (e.g. elasticsearch_rails)
require 'pagy/extras/elasticsearch_rails'
# Extend your models (e.g. application_record.rb)
extend Pagy::ElasticsearchRails
# Use it in your actions
response = Article.pagy_search(params[:q])
@pagy, @response = pagy_elasticsearch_rails(response)(See all the Search Extras)
Customization for client-side|JSON rendering...
# Require the metadata extra in the pagy initializer
require 'pagy/extras/metadata'
# Use it in your actions
pagy, records = pagy(Product.all)
render json: { data: records,
pagy: pagy_metadata(pagy) }(See all the Backend Tools)
Customization for headers pagination for APIs...
# Require the headers extra in the pagy initializer
require 'pagy/extras/headers'
# Use it in your actions
pagy, records = pagy(Product.all)
pagy_headers_merge(pagy)
render json: records(See all the Backend Tools)
Customization for JSON:API pagination...
# Require the jsonapi extra in the pagy initializer
require 'pagy/extras/jsonapi'
# Use it in your actions
pagy, records = pagy(Product.all)
render json: { data: records,
links: pagy_jsonapi_links(pagy) }
# besides the query params will be nested. E.g.: ?page[number]=2&page[size]=100(See all the Backend Tools)
More customization with extras...
Extras add special options and manage different components, behaviors, Frontend or Backend environments... usually by just requiring them (and optionally overriding some default).
- arel: Provides better performance of grouped ActiveRecord collections
- array: Paginate arrays efficiently.
- calendar: Add pagination filtering by calendar time unit (year, quarter, month, week, day, custom)
- countless: Paginate without the need of any count, saving one query per rendering
- elasticsearch_rails: Paginate
ElasticsearchRailsresponse objects - headers: Add RFC-8288 compliant http response headers (and other helpers) useful for API pagination
- jsonapi: Implement the JSON:API specifications for pagination
- meilisearch: Paginate
Meilisearchresults - metadata: Provides the pagination metadata to Javascript frameworks like Vue.js, react.js, etc.
- searchkick: Paginate
Searchkick::Resultsobjects
- bootstrap: Add nav helpers for the Bootstrap pagination component
- bulma: Add nav helpers for the Bulma CSS pagination component
- pagy: Adds the pagy styled versions of the javascript-powered nav helpers and other components to support countless or navless pagination (incremental, auto-incremental, infinite pagination).
- tailwind: Ready to use style snippet for Tailwind CSS
- Pagy::Console: Use pagy in the irb/rails console even without any app nor configuration
- gearbox: Automatically change the number of items per page depending on the page number
- i18n: Use the
I18ngem instead of the faster pagy-i18n implementation - items: Allow the client to request a custom number of items per page with an optional selector UI
- overflow: Allow easy handling of overflowing pages
- standalone: Use pagy without any request object, nor Rack
environment/gem, nor any defined
paramsmethod - trim: Remove the
page=1param from the first page link
See also the How To Page
- Migrate from WillPaginate and Kaminari (practical guide)
- Quick Start
- Documentation
- How To (quick recipes)
- Changelog
- Deprecations
- How Pagy's Docs work?
- Migrate from WillPaginate and Kaminari (practical guide)
- Detailed Gems Comparison (charts and analysis)
- Benchmarks and Memory Profiles Source (Rails app repository)
- Faster Pagination with Pagy introductory tutorial by Sirajus Salekin
- Pagination with Pagy by Tiago Franco
- Quick guide for Pagy with Sinatra and Sequel by Victor Afanasev
- Integrating Pagy with Hanami by Paweล ลwiฤ tkowski
- Stateful Tabs with Pagy by Chris Seelus
- Endless Scroll / Infinite Loading with Turbo Streams & Stimulus by Stefan Wienert.
- Build Load More Pagination with Pagy and Rails Hotwire by Maful. ( This tutorial shows how you can turbo_stream with GET requests).
- Pagination with Hotwire by Jonathan Greenberg
- Pagination and infinite scrolling with Rails and the Hotwire stack by David Colby
- Building a dynamic data grid with search and filters using rails, hotwire and ransack by Benito Serna.
- Pagination for Beginners: What is it? Why bother? by Ben Koshy.
- Handling Pagination When POSTing Complex Search Forms by Ben Koshy.
- How to Override pagy methods only in specific circumstances by Ben Koshy.
- How to make your pagination links sticky + bounce at the bottom of your page by Ben Koshy.
- ๆฅๆฌ่ชใฎๆ็จฟ
- ํ๊ตญ์ด ํํ ๋ฆฌ์ผ
Many thanks to:
- Ben Koshy for his contributions to the documentation, user support and interaction with external frameworks
- GoRails for the great Pagy Screencast and their top notch Rails Episodes
- Imaginary Cloud for continually publishing high-interest articles and helping to share Pagy when it just started
- JetBrains for their free OpenSource license project
- The Stargazers for showing their support
How to contribute
See Contributing
Versioning
- Pagy follows the Semantic Versioning 2.0.0. Please, check the Changelog for breaking changes introduced by mayor versions. Using pessimistic version constraint in your Gemfile will ensure smooth upgrades.
Branches
- The
masterbranch is the latest rubygem-published release. It also contains docs and comment changes that don't affect the published code. It is never force-pushed. - The
devbranch is the development branch with the new code that will be merged in the next release. It could be force-pushed. - Expect any other branch to be internal, experimental, force-pushed, rebased and/or deleted even without merging.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent