© 2017-2022 Domizio DemichelisMIT License

➡ Chat Support on Gitter ➡

Searchkick Extra

This extra deals with the pagination of Searchkick::Results objects either by creating a Pagy object out of an (already paginated) Searchkick::Results object or by creating the Pagy and Searchkick::Results objects from the backend params.


See extras for general usage info.

Require the extra in the pagy.rb initializer:

require 'pagy/extras/searchkick'
Searchkick.extend Pagy::Searchkick   # optional

Passive mode

If you have an already paginated Searchkick::Results object, you can get the Pagy object out of it:

@results = Model.search('*', page: 1, per_page: 10, ...)
@pagy    = Pagy.new_from_searchkick(@results, ...)

Active Mode

If you want Pagy to control the pagination, getting the page from the params, and returning both the Pagy and the Searchkick::Results objects automatically (from the backend params):

Extend your model:

extend Pagy::Searchkick

In a controller use pagy_search in place of search:

results         = Article.pagy_search(params[:q])
@pagy, @results = pagy_searchkick(results, items: 10)


Extend also the Searchkick module if you are going to use Searchkick.pagy_search:

# config/initializers/pagy.rb
Searchkick.extend Pagy::Searchkick

Use pagy_search in place of search:

results         = Searchkick.pagy_search(params[:q], models: [Article, Categories])
@pagy, @results = pagy_searchkick(results, items: 10)


Passive mode

Pagy.new_from_searchkick(results, vars = {})

This constructor accepts a Searchkick::Results as the first argument, plus the usual optional variable hash. It sets the :items, :page and :count pagy variables extracted/calculated out of the Searchkick::Results object.

@results = Model.search('*', page: 2, per_page: 10, ...)
@pagy    = Pagy.new_from_searchkick(@results, ...)

Notice: you have to take care of manually manage all the params for your search, however the method extracts the :items, :page and :count from the results object, so you don’t need to pass that again. If you prefer to manage the pagination automatically, see below.

Active Mode

Pagy::Searchkick module

Extend your model with the Pagy::Searchkick micro-module:

extend Pagy::Searchkick

The Pagy::Searchkick adds the pagy_search class method that you must use in place of the standard search method when you want to paginate the search response.

This method accepts the same arguments of the search method and you must use it in its place. This extra uses it in order to capture the arguments, automatically merging the calculated :page and :per_page options before passing them to the standard search method internally.


Variable Description Default
:searchkick_pagy_search customizable name of the pagy search method :pagy_search
:searchkick_search customizable name of the original search method :search


This extra adds the pagy_searchkick method to the Pagy::Backend to be used when you have to paginate a Searchkick::Results object. It also adds a pagy_searchkick_get_vars sub-method, used for easy customization of variables by overriding.

pagy_searchkick(pagy_search_args, vars={}})

This method is similar to the generic pagy method, but specialized for Searchkick. (see the pagy doc)

It expects to receive a Model.pagy_search(...) result and returns a paginated response. You can use it in a couple of ways:

@pagy, @results = pagy_searchkick(Model.pagy_search(params[:q]), ...)
@records = @results.results

# or directly with the collection you need (e.g. records)
@pagy, @records = pagy_searchkick(Model.pagy_search(params[:q]).results, ...)


This sub-method is similar to the pagy_get_vars sub-method, but it is called only by the pagy_searchkick method. (see the pagy_get_vars doc).