feat(connectors): setValue() -> refine() / currentValue -> `cur…

…rentRefinement`
algolia · Mar 27, 2017 · ec7806c · ec7806c
1 parent 154cdb5
commit ec7806c
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 22 deletions.
diff --git a/src/connectors/hits-per-page-selector/__tests__/connectHitsPerPageSelector-test.js b/src/connectors/hits-per-page-selector/__tests__/connectHitsPerPageSelector-test.js
@@ -89,9 +89,9 @@ describe('connectHitsPerPageSelector', () => {
     });
 
     const firstRenderingOptions = rendering.lastCall.args[0];
-    const {setValue} = firstRenderingOptions;
+    const {refine} = firstRenderingOptions;
     expect(helper.getQueryParameter('hitsPerPage')).toBe(11);
-    setValue(3);
+    refine(3);
     expect(helper.getQueryParameter('hitsPerPage')).toBe(3);
 
     widget.render({
@@ -102,7 +102,7 @@ describe('connectHitsPerPageSelector', () => {
     });
 
     const secondRenderingOptions = rendering.lastCall.args[0];
-    const {setValue: renderSetValue} = secondRenderingOptions;
+    const {refine: renderSetValue} = secondRenderingOptions;
     expect(helper.getQueryParameter('hitsPerPage')).toBe(3);
     renderSetValue(10);
     expect(helper.getQueryParameter('hitsPerPage')).toBe(10);
@@ -134,8 +134,8 @@ describe('connectHitsPerPageSelector', () => {
     });
 
     const firstRenderingOptions = rendering.lastCall.args[0];
-    expect(firstRenderingOptions.currentValue).toBe(7);
-    firstRenderingOptions.setValue(3);
+    expect(firstRenderingOptions.currentRefinement).toBe(7);
+    firstRenderingOptions.refine(3);
 
     widget.render({
       results: new SearchResults(helper.state, [{}]),
@@ -145,7 +145,7 @@ describe('connectHitsPerPageSelector', () => {
     });
 
     const secondRenderingOptions = rendering.lastCall.args[0];
-    expect(secondRenderingOptions.currentValue).toBe(3);
+    expect(secondRenderingOptions.currentRefinement).toBe(3);
   });
 
   it('adds an option for the unselecting values, when the current hitsPerPage is defined elsewhere', () => {
@@ -172,7 +172,7 @@ describe('connectHitsPerPageSelector', () => {
 
     const firstRenderingOptions = rendering.lastCall.args[0];
     expect(firstRenderingOptions.options.length).toBe(3);
-    firstRenderingOptions.setValue(firstRenderingOptions.options[0].value);
+    firstRenderingOptions.refine(firstRenderingOptions.options[0].value);
     expect(helper.getQueryParameter('hitsPerPage')).toBe(undefined);
 
     // Reset the hitsPerPage to an actual value
@@ -187,7 +187,7 @@ describe('connectHitsPerPageSelector', () => {
 
     const secondRenderingOptions = rendering.lastCall.args[0];
     expect(secondRenderingOptions.options.length).toBe(3);
-    secondRenderingOptions.setValue(secondRenderingOptions.options[0].value);
+    secondRenderingOptions.refine(secondRenderingOptions.options[0].value);
     expect(helper.getQueryParameter('hitsPerPage')).toBe(undefined);
   });
 });
diff --git a/src/connectors/hits-per-page-selector/connectHitsPerPageSelector.js b/src/connectors/hits-per-page-selector/connectHitsPerPageSelector.js
@@ -6,8 +6,8 @@ const usage = `Usage:
 var customHitsPerPage = connectHitsPerPageSelector(function render(params, isFirstRendering) {
   // params = {
   //   options,
-  //   currentValue,
-  //   setValue,
+  //   currentRefinement,
+  //   refine,
   //   hasNoResults,
   //   instantSearchInstance,
   //   widgetParams,
@@ -29,8 +29,8 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c
  * @property {Object[]} options Array of objects defining the different values and labels
  * @property {number} options[0].value number of hits to display per page
  * @property {string} options[0].label Label to display in the option
- * @property {number} currentValue the currently selected value of hitsPerPage
- * @property {function(number)} setValue sets the number of hits per page and trigger a search
+ * @property {number} currentRefinement the currently selected value of hitsPerPage
+ * @property {function(number)} refine sets the number of hits per page and trigger a search
  * @property {boolean} hasNoResults true if there were no results in the last search
  * @property {InstantSearch} instantSearchInstance the instance of instantsearch on which the widget is attached
  * @property {Object} widgetParams all original options forwarded to rendering
@@ -85,30 +85,30 @@ export default function connectHitsPerPageSelector(renderFn) {
           options = [{value: undefined, label: ''}].concat(options);
         }
 
-        const currentValue = state.hitsPerPage;
+        const currentRefinement = state.hitsPerPage;
 
         this.setHitsPerPage = value => helper
           .setQueryParameter('hitsPerPage', value)
           .search();
 
         renderFn({
-          currentValue,
+          currentRefinement,
           options,
-          setValue: this.setHitsPerPage,
+          refine: this.setHitsPerPage,
           hasNoResults: true,
           widgetParams,
           instantSearchInstance,
         }, true);
       },
 
       render({state, results, instantSearchInstance}) {
-        const currentValue = state.hitsPerPage;
+        const currentRefinement = state.hitsPerPage;
         const hasNoResults = results.nbHits === 0;
 
         renderFn({
-          currentValue,
+          currentRefinement,
           options,
-          setValue: this.setHitsPerPage,
+          refine: this.setHitsPerPage,
           hasNoResults,
           widgetParams,
           instantSearchInstance,

diff --git a/src/widgets/hits-per-page-selector/hits-per-page-selector.js b/src/widgets/hits-per-page-selector/hits-per-page-selector.js
@@ -17,19 +17,19 @@ const renderer = ({
   cssClasses,
   autoHideContainer,
 }) => ({
-  currentValue,
+  currentRefinement,
   options,
-  setValue,
+  refine,
   hasNoResults,
 }, isFirstRendering) => {
   if (isFirstRendering) return;
 
   ReactDOM.render(
     <Selector
       cssClasses={cssClasses}
-      currentValue={currentValue}
+      currentValue={currentRefinement}
       options={options}
-      setValue={setValue}
+      setValue={refine}
       shouldAutoHideContainer={autoHideContainer && hasNoResults}
     />,
     containerNode