added doc for using Searchkick.pagy_search (closes #319)

ddnexus · Jun 25, 2021 · 28983e6 · 28983e6 · leemcalilly · Jun 25, 2021
1 parent ca74132
commit 28983e6
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/docs/extras/searchkick.md b/docs/extras/searchkick.md
@@ -13,6 +13,7 @@ Require the extra in the `pagy.rb` initializer:
 
 ```ruby
 require 'pagy/extras/searchkick'
+Searchkick.extend Pagy::Searchkick   # optional
 ```
 
 ### Passive mode
@@ -40,6 +41,22 @@ In a controller use `pagy_search` in place of `search`:
 results         = Article.pagy_search(params[:q])
 @pagy, @results = pagy_searchkick(results, items: 10)
 ```
+
+#### Searchkick.search
+
+Extend also the `Searchkick` module if you are going to use `Searchkick.pagy_search`:
+
+```ruby
+# config/initializers/pagy.rb
+Searchkick.extend Pagy::Searchkick
+```
+
+Use `pagy_search` in place of `search`:
+
+```ruby
+results         = Searchkick.pagy_search(params[:q], models: [Article, Categories])
+@pagy, @results = pagy_searchkick(results, items: 10)
+```
 
 ## Files
 

diff --git a/lib/config/pagy.rb b/lib/config/pagy.rb
@@ -56,6 +56,9 @@
 # also the elasticsearch_rails extra that defines the same
 # VARS[:searchkick_search_method] = :pagy_search
 # require 'pagy/extras/searchkick'
+# uncomment if you are going to use Searchkick.pagy_search
+# Searchkick.extend Pagy::Searchkick
+
 
 # Frontend Extras