MAGE-675 - add the config in admin for customers to opt-in and consume that in the js

Author: rachel-trott

Block/Configuration.php

@@ -154,6 +154,7 @@ public function getConfiguration()
                 'infiniteScrollEnabled' => $config->isInfiniteScrollEnabled(),
                 'urlTrackedParameters' => $this->getUrlTrackedParameters(),
                 'isSearchBoxEnabled' => $config->isInstantSearchBoxEnabled(),
+                'hidePagination' => $config->hidePaginationInInstantSearchPage()
             ],
             'autocomplete' => [
                 'enabled' => $config->isAutoCompleteEnabled(),
@@ -381,4 +382,4 @@ protected function getLandingPageConfiguration()
     {
         return $this->isLandingPage() ? $this->getCurrentLandingPage()->getConfiguration() : json_encode([]);
     }
-}
+}

Helper/ConfigHelper.php

@@ -33,6 +33,7 @@ class ConfigHelper
     public const XML_ADD_TO_CART_ENABLE = 'algoliasearch_instant/instant/add_to_cart_enable';
     public const INFINITE_SCROLL_ENABLE = 'algoliasearch_instant/instant/infinite_scroll_enable';
     public const SEARCHBOX_ENABLE = 'algoliasearch_instant/instant/instantsearch_searchbox';
+    public const HIDE_PAGINATION = 'algoliasearch_instant/instant/hide_pagination';
 
     public const IS_POPUP_ENABLED = 'algoliasearch_autocomplete/autocomplete/is_popup_enabled';
     public const NB_OF_PRODUCTS_SUGGESTIONS = 'algoliasearch_autocomplete/autocomplete/nb_of_products_suggestions';
@@ -529,6 +530,16 @@ public function isInfiniteScrollEnabled($storeId = null)
             && $this->configInterface->isSetFlag(self::INFINITE_SCROLL_ENABLE, ScopeInterface::SCOPE_STORE, $storeId);
     }
 
+    /**
+     * @param $storeId
+     * @return bool
+     */
+    public function hidePaginationInInstantSearchPage($storeId = null)
+    {
+        return $this->isInstantEnabled($storeId)
+            && $this->configInterface->isSetFlag(self::HIDE_PAGINATION, ScopeInterface::SCOPE_STORE, $storeId);
+    }
+
     /**
      * @param $storeId
      * @return bool

etc/adminhtml/system.xml

@@ -399,6 +399,18 @@
                         <field id="is_instant_enabled">1</field>
                     </depends>
                 </field>
+                <field id="hide_pagination" translate="label comment" type="select" sortOrder="70" showInDefault="1" showInWebsite="1" showInStore="1">
+                    <label>Hide Pagination for Single Page Results</label>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                    <comment>
+                        <![CDATA[
+                            Hide Pagination if there is only one page in the results
+                        ]]>
+                    </comment>
+                    <depends>
+                        <field id="is_instant_enabled">1</field>
+                    </depends>
+                </field>
             </group>
         </section>
         <section id="algoliasearch_products" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1">

etc/config.xml

@@ -20,6 +20,7 @@
                 <sorts><![CDATA[{"_4581608784535_789":{"attribute":"price","sort":"asc","sortLabel":"Lowest price"},"_2541555584535_585":{"attribute":"price","sort":"desc","sortLabel":"Highest price"},"_5581608784535_898":{"attribute":"created_at","sort":"desc","sortLabel":"Newest first"}}]]></sorts>
                 <instantsearch_searchbox>1</instantsearch_searchbox>
                 <use_virtual_replica>0</use_virtual_replica>
+                <hide_pagination>0</hide_pagination>
             </instant>
         </algoliasearch_instant>
         <algoliasearch_products>

view/frontend/web/instantsearch.js

@@ -392,7 +392,7 @@ define(
                         item:  $('#instant-hit-template').html(),
                     },
                     transformItems: function (items, { results }) {
-                        if (results.nbPages <= 1){
+                        if (results.nbPages <= 1 && algoliaConfig.instant.hidePagination === true){
                             document.getElementById('instant-search-pagination-container').style.display = "none";
                         }else{
                             document.getElementById('instant-search-pagination-container').style.display = "block";
@@ -695,4 +695,4 @@ define(
             return options;
         }
     }
-);
+);