feat(connectors): forward widgetParams to renderFn

Author: iam4x

src/connectors/clear-all/connectClearAll.js

@@ -39,6 +39,7 @@ const clearAll = ({helper, clearAttributes, hasRefinements}) => () => {
  * @property {boolean} hasRefinements
  * @property {function} createURL
  * @property {InstantSearch} instantSearchInstance
+ * @property {Object} widgetParams all original options forwarded to rendering
  */
 
 /**
@@ -50,35 +51,41 @@ const clearAll = ({helper, clearAttributes, hasRefinements}) => () => {
 export default function connectClearAll(renderFn) {
   checkRendering(renderFn, usage);
 
-  return ({excludeAttributes = []}) => ({
-    init({helper, instantSearchInstance, createURL}) {
-      const clearAttributes = getRefinements({}, helper.state)
+  return (widgetParams = {}) => {
+    const {excludeAttributes = []} = widgetParams;
+
+    return {
+      init({helper, instantSearchInstance, createURL}) {
+        const clearAttributes = getRefinements({}, helper.state)
         .map(one => one.attributeName)
         .filter(one => excludeAttributes.indexOf(one) === -1);
-      const hasRefinements = clearAttributes.length !== 0;
-      const preparedCreateURL = () => createURL(clearRefinementsFromState(helper.state));
+        const hasRefinements = clearAttributes.length !== 0;
+        const preparedCreateURL = () => createURL(clearRefinementsFromState(helper.state));
 
-      renderFn({
-        clearAll: () => {},
-        hasRefinements,
-        createURL: preparedCreateURL,
-        instantSearchInstance,
-      }, true);
-    },
+        renderFn({
+          clearAll: () => {},
+          hasRefinements,
+          createURL: preparedCreateURL,
+          instantSearchInstance,
+          widgetParams,
+        }, true);
+      },
 
-    render({results, state, createURL, helper, instantSearchInstance}) {
-      const clearAttributes = getRefinements(results, state)
+      render({results, state, createURL, helper, instantSearchInstance}) {
+        const clearAttributes = getRefinements(results, state)
         .map(one => one.attributeName)
         .filter(one => excludeAttributes.indexOf(one) === -1);
-      const hasRefinements = clearAttributes.length !== 0;
-      const preparedCreateURL = () => createURL(clearRefinementsFromState(state));
+        const hasRefinements = clearAttributes.length !== 0;
+        const preparedCreateURL = () => createURL(clearRefinementsFromState(state));
 
-      renderFn({
-        clearAll: clearAll({helper, clearAttributes, hasRefinements}),
-        hasRefinements,
-        createURL: preparedCreateURL,
-        instantSearchInstance,
-      }, false);
-    },
-  });
+        renderFn({
+          clearAll: clearAll({helper, clearAttributes, hasRefinements}),
+          hasRefinements,
+          createURL: preparedCreateURL,
+          instantSearchInstance,
+          widgetParams,
+        }, false);
+      },
+    };
+  };
 }

src/connectors/current-refined-values/connectCurrentRefinedValues.js

@@ -33,6 +33,7 @@ connectCurrentRefinedValues({
  * @property {string[]} clearRefinementURLs,individual url where a single refinement is cleared
  * @property {Refinements[]} refinements,all the current refinements
  * @property {InstantsSearch} instantSearchInstance the instance of instantsearch.js
+ * @property {Object} widgetParams all original options forwarded to rendering
  */
 
 /**
@@ -56,10 +57,8 @@ connectCurrentRefinedValues({
  * @param {function(CurrentRefinedValuesRenderingOptions)} renderCurrentRefinedValues the custom rendering function
  * @return {function(CurrentRefinedValuesWidgetOptions): CurrentRefinedValuesWidget} a function that creates CurrentRefinedValues widget
  */
-const connectCurrentRefinedValues = renderCurrentRefinedValues => ({
-    attributes = [],
-    onlyListedAttributes = false,
-  }) => {
+const connectCurrentRefinedValues = renderCurrentRefinedValues => (widgetParams = {}) => {
+  const {attributes = [], onlyListedAttributes = false} = widgetParams;
   const attributesOK = isArray(attributes) &&
     reduce(
       attributes,
@@ -108,6 +107,7 @@ const connectCurrentRefinedValues = renderCurrentRefinedValues => ({
         clearRefinementURLs,
         refinements,
         instantSearchInstance,
+        widgetParams,
       }, true);
     },
     render({results, helper, state, createURL, instantSearchInstance}) {
@@ -125,6 +125,7 @@ const connectCurrentRefinedValues = renderCurrentRefinedValues => ({
         clearRefinementURLs,
         refinements,
         instantSearchInstance,
+        widgetParams,
       }, false);
     },
   };

src/connectors/hierarchical-menu/connectHierarchicalMenu.js

@@ -41,6 +41,7 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c
  * @property {Object[]} items
  * @property {function} refine
  * @property {InstantSearch} instantSearchInstance
+ * @property {Object} widgetParams all original options forwarded to rendering
  */
 
  /**
@@ -51,14 +52,16 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c
 export default function connectHierarchicalMenu(renderFn) {
   checkRendering(renderFn, usage);
 
-  return ({
-    attributes,
-    separator = ' > ',
-    rootPath = null,
-    showParentLevel = true,
-    limit = 10,
-    sortBy = ['name:asc'],
-  } = {}) => {
+  return (widgetParams = {}) => {
+    const {
+      attributes,
+      separator = ' > ',
+      rootPath = null,
+      showParentLevel = true,
+      limit = 10,
+      sortBy = ['name:asc'],
+    } = widgetParams;
+
     if (!attributes || !attributes.length) {
       throw new Error(usage);
     }
@@ -98,6 +101,7 @@ export default function connectHierarchicalMenu(renderFn) {
           items: [],
           refine: this._refine,
           instantSearchInstance,
+          widgetParams,
         }, true);
       },
 
@@ -130,6 +134,7 @@ export default function connectHierarchicalMenu(renderFn) {
           items,
           refine: this._refine,
           instantSearchInstance,
+          widgetParams,
         }, false);
       },
     };

src/connectors/hits-per-page-selector/connectHitsPerPageSelector.js

@@ -20,9 +20,8 @@ hitsPerPageSelector({
   options,
 })`;
 
-const connectHitsPerPageSelector = renderHitsPerPageSelector => ({
-    options: userOptions,
-  } = {}) => {
+const connectHitsPerPageSelector = renderHitsPerPageSelector => (widgetParams = {}) => {
+  const {options: userOptions} = widgetParams;
   let options = userOptions;
 
   if (!options) {
@@ -66,6 +65,7 @@ with \`value: hitsPerPage\` (hitsPerPage: ${state.hitsPerPage})`
         options,
         setValue: this.setHitsPerPage,
         hasNoResults: true,
+        widgetParams,
       }, true);
     },
 
@@ -78,6 +78,7 @@ with \`value: hitsPerPage\` (hitsPerPage: ${state.hitsPerPage})`
         options,
         setValue: this.setHitsPerPage,
         hasNoResults,
+        widgetParams,
       }, false);
     },
   };

src/connectors/hits/connectHits.js

@@ -26,6 +26,7 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c
  * @property {Object[]} hits
  * @property {Object} results
  * @property {InstantSearch} instantSearchInstance
+ * @property {Object} widgetParams all original options forwarded to rendering
  */
 
  /**
@@ -36,25 +37,31 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c
 export default function connectHits(renderFn) {
   checkRendering(renderFn, usage);
 
-  return ({hitsPerPage = 20}) => ({
-    getConfiguration() {
-      return {hitsPerPage};
-    },
-
-    init({instantSearchInstance}) {
-      renderFn({
-        hits: [],
-        results: undefined,
-        instantSearchInstance,
-      }, true);
-    },
-
-    render({results, instantSearchInstance}) {
-      renderFn({
-        hits: results.hits,
-        results,
-        instantSearchInstance,
-      }, false);
-    },
-  });
+  return (widgetOptions = {}) => {
+    const {hitsPerPage = 20} = widgetOptions;
+
+    return {
+      getConfiguration() {
+        return {hitsPerPage};
+      },
+
+      init({instantSearchInstance}) {
+        renderFn({
+          hits: [],
+          results: undefined,
+          instantSearchInstance,
+          widgetOptions,
+        }, true);
+      },
+
+      render({results, instantSearchInstance}) {
+        renderFn({
+          hits: results.hits,
+          results,
+          instantSearchInstance,
+          widgetOptions,
+        }, false);
+      },
+    };
+  };
 }

src/connectors/infinite-hits/connectInfiniteHits.js

@@ -40,9 +40,8 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c
 export default function connectInfiniteHits(renderFn) {
   checkRendering(renderFn, usage);
 
-  return ({
-    hitsPerPage = 20,
-  }) => {
+  return widgetParams => {
+    const {hitsPerPage = 20} = widgetParams;
     let hitsCache = [];
     const getShowMore = helper => () => helper.nextPage().search();
 
@@ -60,6 +59,7 @@ export default function connectInfiniteHits(renderFn) {
           showMore: this.showMore,
           isLastPage: true,
           instantSearchInstance,
+          widgetParams,
         }, true);
       },
 
@@ -78,6 +78,7 @@ export default function connectInfiniteHits(renderFn) {
           showMore: this.showMore,
           isLastPage,
           instantSearchInstance,
+          widgetParams,
         }, false);
       },
     };

src/connectors/menu/connectMenu.js

@@ -39,6 +39,7 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c
  * @property {AlgoliaSearchHelper} helper
  * @property {InstantSearch} instantSearchInstance
  * @property {boolean} canRefine
+ * @property {Object} widgetParams all original options forwarded to rendering
  */
 
  /**
@@ -49,11 +50,13 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c
 export default function connectMenu(renderFn) {
   checkRendering(renderFn, usage);
 
-  return ({
-    attributeName,
-    limit = 10,
-    sortBy = ['count:desc', 'name:asc'],
-  }) => {
+  return widgetParams => {
+    const {
+      attributeName,
+      limit = 10,
+      sortBy = ['count:desc', 'name:asc'],
+    } = widgetParams;
+
     if (!attributeName) {
       throw new Error(usage);
     }
@@ -91,6 +94,7 @@ export default function connectMenu(renderFn) {
           helper: this._helper,
           instantSearchInstance,
           canRefine: false,
+          widgetParams,
         }, true);
       },
 
@@ -105,6 +109,7 @@ export default function connectMenu(renderFn) {
           helper: this._helper,
           instantSearchInstance,
           canRefine: items.length > 0,
+          widgetParams,
         }, false);
       },
     };

src/connectors/numeric-refinement-list/connectNumericRefinementList.js

@@ -35,10 +35,12 @@ connectNumericRefinementList(renderer)({
   attributeName,
   options
 })`;
-const connectNumericRefinementList = numericRefinementListRendering => ({
-    attributeName,
-    options,
-  }) => {
+const connectNumericRefinementList = numericRefinementListRendering => widgetParams => {
+  const {
+      attributeName,
+      options,
+    } = widgetParams;
+
   if (!attributeName || !options) {
     throw new Error(usage);
   }
@@ -66,6 +68,7 @@ const connectNumericRefinementList = numericRefinementListRendering => ({
         hasNoResults: true,
         toggleRefinement: this._toggleRefinement,
         instantSearchInstance,
+        widgetParams,
       }, true);
     },
     render({results, state, instantSearchInstance}) {
@@ -83,6 +86,7 @@ const connectNumericRefinementList = numericRefinementListRendering => ({
         hasNoResults: results.nbHits === 0,
         toggleRefinement: this._toggleRefinement,
         instantSearchInstance,
+        widgetParams,
       }, false);
     },
   };

src/connectors/numeric-selector/connectNumericSelector.js

@@ -36,6 +36,7 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c
  * @property {function} setValue
  * @property {boolean} hasNoResults
  * @property {InstantSearch} instantSearchInstance
+ * @property {Object} widgetParams all original options forwarded to rendering
  */
 
  /**
@@ -46,11 +47,13 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c
 export default function connectNumericSelector(renderFn) {
   checkRendering(renderFn, usage);
 
-  return ({
-    attributeName,
-    options,
-    operator = '=',
-  }) => {
+  return widgetParams => {
+    const {
+      attributeName,
+      options,
+      operator = '=',
+    } = widgetParams;
+
     if (!attributeName || !options) {
       throw new Error(usage);
     }
@@ -81,6 +84,7 @@ export default function connectNumericSelector(renderFn) {
           setValue: this._refine,
           hasNoResults: true,
           instantSearchInstance,
+          widgetParams,
         }, true);
       },
 
@@ -91,6 +95,7 @@ export default function connectNumericSelector(renderFn) {
           setValue: this._refine,
           hasNoResults: results.nbHits === 0,
           instantSearchInstance,
+          widgetParams,
         }, false);
       },