fix(SFFV): search status we're not inside search state (#125)

algolia · Jun 13, 2017 · 5f3e670 · 5f3e670
1 parent 2cd9a04
commit 5f3e670
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 1 deletion.
diff --git a/docgen/src/guide/Conditional_display.md b/docgen/src/guide/Conditional_display.md
@@ -75,6 +75,22 @@ const content = createConnector({
  });
 ```
 
+Alternatively, if you're using the search in List feature then you can know when the search results are loading by doing: 
+
+```jsx
+const content = createConnector({
+    displayName: 'ConditionalError',
+    getProvidedProps(props, searchState, searchResults) {
+      return {loading: searchResults.searchingForFacetValues};
+    },
+})(({loading}) => {
+    const content = loading
+      ? <div>We are loading</div>
+      : <div>Search finished</div>;
+    return <div>{content}</div>;
+ });
+```
+
 <div class="guide-nav">
     <div class="guide-nav-left">
         Previous: <a href="guide/Custom_connectors.html">← Custom Connectors</a>

diff --git a/packages/react-instantsearch/src/core/createConnector.js b/packages/react-instantsearch/src/core/createConnector.js
@@ -165,8 +165,14 @@ export default function createConnector(connectorDesc) {
         widgets,
         metadata,
         resultsFacetValues,
+        searchingForFacetValues,
       } = store.getState();
-      const searchState = { results, searching, error };
+      const searchState = {
+        results,
+        searching,
+        error,
+        searchingForFacetValues,
+      };
       return connectorDesc.getProvidedProps.call(
         this,
         props,

diff --git a/packages/react-instantsearch/src/core/createConnector.test.js b/packages/react-instantsearch/src/core/createConnector.test.js
@@ -12,6 +12,7 @@ function createState() {
     results: {},
     error: {},
     searching: {},
+    searchingForFacetValues: {},
     metadata: {},
   };
 }
@@ -47,6 +48,9 @@ describe('createConnector', () => {
       expect(args[2].results).toBe(state.results);
       expect(args[2].error).toBe(state.error);
       expect(args[2].searching).toBe(state.searching);
+      expect(args[2].searchingForFacetValues).toBe(
+        state.searchingForFacetValues
+      );
       expect(args[3]).toBe(state.metadata);
       expect(wrapper.find(Dummy).props()).toEqual({
         ...props,
@@ -83,6 +87,10 @@ describe('createConnector', () => {
       expect(args[2].results).toBe(state.results);
       expect(args[2].error).toBe(state.error);
       expect(args[2].searching).toBe(state.searching);
+      expect(args[2].searchingForFacetValues).toBe(
+        state.searchingForFacetValues
+      );
+
       expect(args[3]).toBe(state.metadata);
       expect(wrapper.find(Dummy).props()).toEqual({
         ...props,
@@ -138,6 +146,10 @@ describe('createConnector', () => {
       expect(args[2].results).toBe(state.results);
       expect(args[2].error).toBe(state.error);
       expect(args[2].searching).toBe(state.searching);
+      expect(args[2].searchingForFacetValues).toBe(
+        state.searchingForFacetValues
+      );
+
       expect(args[3]).toBe(state.metadata);
       expect(wrapper.find(Dummy).props()).toEqual({
         ...props,
@@ -198,6 +210,9 @@ describe('createConnector', () => {
       expect(args[2].results).toBe(state.results);
       expect(args[2].error).toBe(state.error);
       expect(args[2].searching).toBe(state.searching);
+      expect(args[2].searchingForFacetValues).toBe(
+        state.searchingForFacetValues
+      );
       expect(args[3]).toBe(state.metadata);
       expect(wrapper.find(Dummy).props()).toEqual({
         ...props,

diff --git a/packages/react-instantsearch/src/core/createInstantSearchManager.js b/packages/react-instantsearch/src/core/createInstantSearchManager.js
@@ -42,6 +42,7 @@ export default function createInstantSearchManager({
     results: null,
     error: null,
     searching: false,
+    searchingForFacetValues: false,
   });
 
   let skip = false;

diff --git a/packages/react-instantsearch/src/core/createInstantSearchManager.test.js b/packages/react-instantsearch/src/core/createInstantSearchManager.test.js
@@ -39,6 +39,7 @@ describe('createInstantSearchManager', () => {
       metadata: [],
       results: null,
       searching: false,
+      searchingForFacetValues: false,
       widgets: {},
     });