#

# Quick Start


Prevent unexpected breaking changes in stable releases (see omit the patch version):

Gemfile (stable)
gem 'pagy', '~> 43.3' # Omit the patch segment to avoid breaking changes
  • Include the pagy method where you are going to use it (usually ApplicationController):

    include Pagy::Method
  • Use it to paginate any collection with any technique:

    @pagy, @records = pagy(:offset, Product.some_scope, **options) # :offset paginator
    @pagy, @records = pagy(:keyset, Product.some_scope, **options) # :keyset paginator
    @pagy, @records = pagy(...)

    See all the available paginators

  • Render navigator tags and other helpers with the @pagy instance methods:

    <%# Render navigation bar helpers with various types and styles %>
    <%== @pagy.series_nav %>
    <%== @pagy.series_nav_js(:bootstrap) %>
    <%== @pagy.input_nav_js(:bulma) %>
    <%== @pagy.info_tag %>

    See all the available @pagy methods