feat(sort-by-selector): currentValue -> currentRefinement

algolia · Mar 27, 2017 · e94c8c7 · e94c8c7
1 parent 7e86be3
commit e94c8c7
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 14 deletions.
diff --git a/src/connectors/sort-by-selector/__tests__/connectSortBySelector-test.js b/src/connectors/sort-by-selector/__tests__/connectSortBySelector-test.js
@@ -38,8 +38,8 @@ describe('connectSortBySelector', () => {
       expect(isFirstRendering).toBe(true);
 
       // should provide good values for the first rendering
-      const {currentValue, options, widgetParams} = rendering.lastCall.args[0];
-      expect(currentValue).toBe(helper.state.index);
+      const {currentRefinement, options, widgetParams} = rendering.lastCall.args[0];
+      expect(currentRefinement).toBe(helper.state.index);
       expect(widgetParams).toEqual({indices});
       expect(options).toEqual([
         {label: 'Sort products by relevance', value: 'relevance'},
@@ -60,8 +60,8 @@ describe('connectSortBySelector', () => {
       expect(isFirstRendering).toBe(false);
 
       // should provide good values after the first search
-      const {currentValue, options} = rendering.lastCall.args[0];
-      expect(currentValue).toBe(helper.state.index);
+      const {currentRefinement, options} = rendering.lastCall.args[0];
+      expect(currentRefinement).toBe(helper.state.index);
       expect(options).toEqual([
         {label: 'Sort products by relevance', value: 'relevance'},
         {label: 'Sort products by price', value: 'priceASC'},
@@ -94,8 +94,8 @@ describe('connectSortBySelector', () => {
     { // first rendering
       expect(helper.state.index).toBe(indices[0].name);
       const renderOptions = rendering.lastCall.args[0];
-      const {refine, currentValue} = renderOptions;
-      expect(currentValue).toBe(helper.state.index);
+      const {refine, currentRefinement} = renderOptions;
+      expect(currentRefinement).toBe(helper.state.index);
       refine('bip');
       expect(helper.state.index).toBe('bip');
       expect(helper.search.callCount).toBe(1);
@@ -111,8 +111,8 @@ describe('connectSortBySelector', () => {
     { // Second rendering
       expect(helper.state.index).toBe('bip');
       const renderOptions = rendering.lastCall.args[0];
-      const {refine, currentValue} = renderOptions;
-      expect(currentValue).toBe('bip');
+      const {refine, currentRefinement} = renderOptions;
+      expect(currentRefinement).toBe('bip');
       refine('bop');
       expect(helper.state.index).toBe('bop');
       expect(helper.search.callCount).toBe(2);

diff --git a/src/connectors/sort-by-selector/connectSortBySelector.js b/src/connectors/sort-by-selector/connectSortBySelector.js
@@ -3,7 +3,7 @@ import {checkRendering} from '../../lib/utils.js';
 const usage = `Usage:
 var customSortBySelector = connectSortBySelector(function render(params, isFirstRendering) {
   // params = {
-  //   currentValue,
+  //   currentRefinement,
   //   options,
   //   refine,
   //   hasNoResults,
@@ -26,7 +26,7 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c
 
 /**
  * @typedef {Object} SortBySelectorRenderingOptions
- * @property {string} currentValue the currently selected index
+ * @property {string} currentRefinement the currently selected index
  * @property {Object[]} options all the available indices
  * @property {function} refine switch indices and do a new search
  * @property {boolean} hasNoResults a boolean that indicates if there were no results during that last search
@@ -65,7 +65,7 @@ export default function connectSortBySelector(renderFn) {
           .search();
 
         renderFn({
-          currentValue: currentIndex,
+          currentRefinement: currentIndex,
           options: selectorOptions,
           refine: this.setIndex,
           hasNoResults: true,
@@ -76,7 +76,7 @@ export default function connectSortBySelector(renderFn) {
 
       render({helper, results, instantSearchInstance}) {
         renderFn({
-          currentValue: helper.getIndex(),
+          currentRefinement: helper.getIndex(),
           options: selectorOptions,
           refine: this.setIndex,
           hasNoResults: results.nbHits === 0,

diff --git a/src/widgets/sort-by-selector/sort-by-selector.js b/src/widgets/sort-by-selector/sort-by-selector.js
@@ -13,7 +13,7 @@ const renderer = ({
   cssClasses,
   autoHideContainer,
 }) => ({
-  currentValue,
+  currentRefinement,
   options,
   refine,
   hasNoResults,
@@ -25,7 +25,7 @@ const renderer = ({
   ReactDOM.render(
     <Selector
       cssClasses={cssClasses}
-      currentValue={currentValue}
+      currentValue={currentRefinement}
       options={options}
       setValue={refine}
       shouldAutoHideContainer={shouldAutoHideContainer}