feat(connectors.refinement-list): provide currentRefinement to renderFn

Author: iam4x

src/connectors/refinement-list/__tests__/connectRefinementList-test.js

@@ -245,4 +245,52 @@ describe('connectRefinementList', () => {
       },
     ]);
   });
+
+  it('provides the correct `currentRefinement` value', () => {
+    const widget = makeWidget({attributeName: 'category'});
+
+    const helper = algoliasearchHelper(fakeClient, '', widget.getConfiguration({}));
+    helper.search = sinon.stub();
+
+    helper.toggleRefinement('category', 'Decoration');
+
+    widget.init({
+      helper,
+      state: helper.state,
+      createURL: () => '#',
+      onHistoryChange: () => {},
+    });
+
+    const firstRenderingOptions = rendering.lastCall.args[0];
+    expect(firstRenderingOptions.currentRefinement).toBe(null);
+
+    widget.render({
+      results: new SearchResults(helper.state, [{
+        hits: [],
+        facets: {
+          category: {
+            Decoration: 880,
+          },
+        },
+      }, {
+        facets: {
+          category: {
+            Decoration: 880,
+            Outdoor: 47,
+          },
+        },
+      }]),
+      state: helper.state,
+      helper,
+      createURL: () => '#',
+    });
+
+    const secondRenderingOptions = rendering.lastCall.args[0];
+    expect(secondRenderingOptions.currentRefinement).toEqual({
+      name: 'Decoration',
+      highlighted: 'Decoration',
+      count: 880,
+      isRefined: true,
+    });
+  });
 });

src/connectors/refinement-list/connectRefinementList.js

@@ -12,6 +12,7 @@ var customRefinementList = connectRefinementList(function render(params) {
   //   instantSearchInstance,
   //   canRefine,
   //   widgetParams,
+  //   currentRefinement,
   // }
 });
 search.addWidget(
@@ -52,6 +53,7 @@ export const checkUsage = ({attributeName, operator, usageMessage}) => {
  * @property {boolean} canRefine indicates if a refinement can be applied
  * @property {Object} widgetParams all original options forwarded to rendering
  * @property {InstantSearch} instantSearchInstance the instance of instantsearch on which the widget is attached
+ * @property {Object} currentRefinement the refinement currently applied
  */
 
 /**
@@ -100,6 +102,7 @@ export default function connectRefinementList(renderFn) {
         isFromSearch,
         canRefine: isFromSearch || items.length > 0,
         widgetParams,
+        currentRefinement: items.find(({isRefined}) => isRefined) || null,
       }, isFirstSearch);
     };