feat(instantsearch): add support for hitsPerPage configuration (#74)

* feat(instantsearch): add support for hitsPerPage configuration * docs(instantsearch): document hitsPerPage option
algolia · Sep 20, 2018 · 66f1a20 · 66f1a20
1 parent eee51c1
commit 66f1a20
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 0 deletions.
diff --git a/app/README.md b/app/README.md
@@ -94,6 +94,7 @@ Here is a full breakdown of the available options for the JavaScript library:
     },
     instantsearch: {
       enabled: true,                      // is the instantsearch feature enabled?
+      hitsPerPage: 20,                    // the number of suggestions to display
       paginationSelector: '.pagination',  // the DOM selector for the current pagination (to hide it)
       reuseAutocomplete: false,           // do not add a search input for the instant-search page
       hideAutocomplete: true,             // whether or not to hide the autocomplete on the instantsearch page (ignored if reuseAutocomplete is used)

diff --git a/app/src/AlgoliasearchZendeskHC.js b/app/src/AlgoliasearchZendeskHC.js
@@ -28,6 +28,7 @@ const optionsStructure = {required: true, type: 'Object', children: {
   indexPrefix: {type: 'string', value: 'zendesk_'},
   instantsearch: {type: 'Object', value: {}, children: {
     enabled: {type: 'boolean', value: true},
+    hitsPerPage: {type: 'number', value: 20},
     paginationSelector: {type: 'string', value: '.pagination'},
     reuseAutocomplete: {type: 'boolean', value: false},
     hideAutocomplete: {type: 'boolean', value: true},

diff --git a/app/src/instantsearch.js b/app/src/instantsearch.js
@@ -70,6 +70,7 @@ class InstantSearch {
     highlightColor,
     instantsearch: {
       enabled,
+      hitsPerPage,
       selector,
       paginationSelector,
       reuseAutocomplete,
@@ -190,6 +191,7 @@ class InstantSearch {
     this.instantsearch.addWidget(
       instantsearch.widgets.hits({
         container: '#algolia-hits',
+        hitsPerPage,
         templates: {
           empty: templates.instantsearch.noResult,
           item: templates.instantsearch.hit

diff --git a/docs/documentation.md b/docs/documentation.md
@@ -86,6 +86,7 @@ Here is a full breakdown of the available options for the JavaScript library:
     },
     instantsearch: {
       enabled: true,                      // is the instantsearch feature enabled?
+      hitsPerPage: 20,                    // the number of suggestions to display
       paginationSelector: '.pagination',  // the DOM selector for the current pagination (to hide it)
       reuseAutocomplete: false,           // do not add a search input for the instant-search page
       hideAutocomplete: true,             // whether or not to hide the autocomplete on the instantsearch page (ignored if reuseAutocomplete is used)