will_paginate Overview

will_paginate is a flexible and widely-used pagination library for Ruby web frameworks. It provides a simple but powerful API for paginating query results and includes view helpers for rendering pagination links in web applications.

Originally designed for Ruby on Rails, its support has expanded to include Sinatra, Hanami, Sequel, and even plain Ruby arrays, making it a versatile tool for adding pagination to almost any Ruby project.

ℹ️ Project Status As noted in the project's README, will_paginate is currently in maintenance mode. It is stable and functional but will not be receiving new features. For projects requiring active development and new functionality, you may wish to explore alternatives.

Key Features

  • Framework Integration: Seamlessly integrates with ActiveRecord (Rails), Sequel, and Mongoid to paginate database queries.
  • Collection Pagination: Provides a simple paginate method on the Array class to easily paginate in-memory collections.
  • View Helpers: Offers easy-to-use helpers (will_paginate, page_entries_info) for rendering pagination controls in Rails, Sinatra, and Hanami views.
  • Customizable Renderers: Allows complete control over the generated HTML by providing your own link renderer class.
  • Internationalization (I18n): Supports translation for all visible text, including previous/next labels and page-entry information.
  • Clean and Accessible Markup: Generates semantic HTML with ARIA attributes for improved accessibility.