react-instantsearch 7.20.2 → 7.22.0

package/dist/cjs/index.js

@@ -35,4 +35,15 @@ Object.keys(_components).forEach(function (key) {
       return _components[key];
     }
   });
+});
+var _useStickToBottom = require("./lib/useStickToBottom");
+Object.keys(_useStickToBottom).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _useStickToBottom[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _useStickToBottom[key];
+    }
+  });
 });

package/dist/cjs/widgets/Autocomplete.js

@@ -10,10 +10,10 @@ var _reactInstantsearchCore = require("react-instantsearch-core");
 var _AutocompleteSearch = require("../components/AutocompleteSearch");
 var _ReverseHighlight = require("./ReverseHighlight");
 var _excluded = ["indices", "showSuggestions", "showRecent", "searchParameters"],
-  _excluded2 = ["indicesConfig", "refineSearchBox", "getSearchPageURL", "onSelect", "indexUiState", "isSearchPage", "panelComponent", "showRecent", "showSuggestions", "placeholder"];
+  _excluded2 = ["indicesConfig", "refineSearchBox", "getSearchPageURL", "onSelect", "indexUiState", "isSearchPage", "panelComponent", "showRecent", "recentSearchConfig", "showSuggestions", "placeholder"];
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
-function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 function _toConsumableArray(r) { return _arrayWithoutHoles(r) || _iterableToArray(r) || _unsupportedIterableToArray(r) || _nonIterableSpread(); }
 function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
 function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
@@ -60,6 +60,7 @@ var useStorage = (0, _instantsearchUiComponents.createAutocompleteStorage)({
   useState: _react.useState
 });
 function EXPERIMENTAL_Autocomplete(_ref) {
+  var _showRecent$className, _showRecent$className2, _showRecent$className3, _showRecent$className4;
   var _ref$indices = _ref.indices,
     indices = _ref$indices === void 0 ? [] : _ref$indices,
     showSuggestions = _ref.showSuggestions,
@@ -85,10 +86,12 @@ function EXPERIMENTAL_Autocomplete(_ref) {
       headerComponent: showSuggestions.headerComponent,
       itemComponent: showSuggestions.itemComponent || function (_ref2) {
         var item = _ref2.item,
-          onSelect = _ref2.onSelect;
+          onSelect = _ref2.onSelect,
+          onApply = _ref2.onApply;
         return /*#__PURE__*/_react.default.createElement(AutocompleteSuggestion, {
           item: item,
-          onSelect: onSelect
+          onSelect: onSelect,
+          onApply: onApply
         }, /*#__PURE__*/_react.default.createElement(ConditionalReverseHighlight, {
           item: item
         }));
@@ -105,6 +108,16 @@ function EXPERIMENTAL_Autocomplete(_ref) {
       getURL: showSuggestions.getURL
     });
   }
+  var recentSearchConfig = showRecent ? {
+    headerComponent: _typeof(showRecent) === 'object' ? showRecent.headerComponent : undefined,
+    itemComponent: _typeof(showRecent) === 'object' && showRecent.itemComponent ? showRecent.itemComponent : AutocompleteRecentSearch,
+    classNames: {
+      root: (0, _instantsearchUiComponents.cx)('ais-AutocompleteRecentSearches', _typeof(showRecent) === 'object' ? (_showRecent$className = showRecent.classNames) === null || _showRecent$className === void 0 ? void 0 : _showRecent$className.root : undefined),
+      list: (0, _instantsearchUiComponents.cx)('ais-AutocompleteRecentSearchesList', _typeof(showRecent) === 'object' ? (_showRecent$className2 = showRecent.classNames) === null || _showRecent$className2 === void 0 ? void 0 : _showRecent$className2.list : undefined),
+      header: (0, _instantsearchUiComponents.cx)('ais-AutocompleteRecentSearchesHeader', _typeof(showRecent) === 'object' ? (_showRecent$className3 = showRecent.classNames) === null || _showRecent$className3 === void 0 ? void 0 : _showRecent$className3.header : undefined),
+      item: (0, _instantsearchUiComponents.cx)('ais-AutocompleteRecentSearchesItem', _typeof(showRecent) === 'object' ? (_showRecent$className4 = showRecent.classNames) === null || _showRecent$className4 === void 0 ? void 0 : _showRecent$className4.item : undefined)
+    }
+  } : undefined;
   var isSearchPage = (0, _react.useMemo)(function () {
     return typeof indexRenderState.hits !== 'undefined' || typeof indexRenderState.infiniteHits !== 'undefined';
   }, [indexRenderState]);
@@ -121,6 +134,7 @@ function EXPERIMENTAL_Autocomplete(_ref) {
     indexUiState: indexUiState,
     isSearchPage: isSearchPage,
     showRecent: showRecent,
+    recentSearchConfig: recentSearchConfig,
     showSuggestions: showSuggestions
   }))));
 }
@@ -133,6 +147,7 @@ function InnerAutocomplete(_ref3) {
     isSearchPage = _ref3.isSearchPage,
     PanelComponent = _ref3.panelComponent,
     showRecent = _ref3.showRecent,
+    recentSearchConfig = _ref3.recentSearchConfig,
     showSuggestions = _ref3.showSuggestions,
     placeholder = _ref3.placeholder,
     props = _objectWithoutProperties(_ref3, _excluded2);
@@ -158,6 +173,9 @@ function InnerAutocomplete(_ref3) {
         refineSearchBox(query);
         storage.onAdd(query);
       },
+      onApply: function onApply(query) {
+        refineAutocomplete(query);
+      },
       onSelect: userOnSelect !== null && userOnSelect !== void 0 ? userOnSelect : function (_ref4) {
         var query = _ref4.query,
           setQuery = _ref4.setQuery,
@@ -180,30 +198,29 @@ function InnerAutocomplete(_ref3) {
     getItemProps = _usePropGetters.getItemProps,
     getPanelProps = _usePropGetters.getPanelProps,
     getRootProps = _usePropGetters.getRootProps;
-  var AutocompleteRecentSearchComponent = _typeof(showRecent) === 'object' && showRecent.itemComponent || AutocompleteRecentSearch;
   var elements = {};
-  if (showRecent) {
-    elements.recent = /*#__PURE__*/_react.default.createElement(AutocompleteIndex
-    // @ts-ignore - there seems to be problems with React.ComponentType and this, but it's actually correct
-    , {
+  if (showRecent && recentSearchConfig) {
+    var RecentSearchItemComponent = recentSearchConfig.itemComponent;
+    elements.recent = /*#__PURE__*/_react.default.createElement(AutocompleteIndex, {
+      HeaderComponent: recentSearchConfig.headerComponent
+      // @ts-ignore - there seems to be problems with React.ComponentType and this, but it's actually correct
+      ,
       ItemComponent: function ItemComponent(_ref5) {
         var item = _ref5.item,
-          onSelect = _ref5.onSelect;
-        return /*#__PURE__*/_react.default.createElement(AutocompleteRecentSearchComponent, {
+          onSelect = _ref5.onSelect,
+          onApply = _ref5.onApply;
+        return /*#__PURE__*/_react.default.createElement(RecentSearchItemComponent, {
           item: item,
           onSelect: onSelect,
           onRemoveRecentSearch: function onRemoveRecentSearch() {
             return storage.onRemove(item.query);
-          }
+          },
+          onApply: onApply
         }, /*#__PURE__*/_react.default.createElement(ConditionalReverseHighlight, {
           item: item
         }));
       },
-      classNames: {
-        root: 'ais-AutocompleteRecentSearches',
-        list: 'ais-AutocompleteRecentSearchesList',
-        item: 'ais-AutocompleteRecentSearchesItem'
-      },
+      classNames: recentSearchConfig.classNames,
       items: storageHits,
       getItemProps: getItemProps,
       key: "recentSearches"

package/dist/es/index.d.ts

@@ -1,3 +1,4 @@
 export * from 'react-instantsearch-core';
 export * from './widgets';
 export * from './components';
+export * from './lib/useStickToBottom';

package/dist/es/index.js

@@ -1,3 +1,5 @@
 export * from 'react-instantsearch-core';
 export * from "./widgets/index.js";
-export * from "./components/index.js";
+export * from "./components/index.js";
+// @internal Internal exports (not part of the public API)
+export * from "./lib/useStickToBottom.js";

package/dist/es/widgets/Autocomplete.d.ts

@@ -22,14 +22,21 @@ export type AutocompleteProps<TItem extends BaseHit> = ComponentProps<'div'> & {
          * Storage key to use in the local storage.
          */
         storageKey?: string;
+        /**
+         * Component to use for the header, before the list of items.
+         */
+        headerComponent?: AutocompleteIndexProps<{
+            query: string;
+        }>['HeaderComponent'];
         /**
          * Component to use for each recent search item.
          */
-        itemComponent: AutocompleteIndexProps<{
+        itemComponent?: AutocompleteIndexProps<{
             query: string;
         }>['ItemComponent'] & {
             onRemoveRecentSearch: () => void;
         };
+        classNames?: Partial<AutocompleteIndexClassNames>;
     };
     getSearchPageURL?: (nextUiState: IndexUiState) => string;
     onSelect?: AutocompleteIndexConfig<TItem>['onSelect'];

package/dist/es/widgets/Autocomplete.js

@@ -1,7 +1,7 @@
 var _excluded = ["indices", "showSuggestions", "showRecent", "searchParameters"],
-  _excluded2 = ["indicesConfig", "refineSearchBox", "getSearchPageURL", "onSelect", "indexUiState", "isSearchPage", "panelComponent", "showRecent", "showSuggestions", "placeholder"];
-function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+  _excluded2 = ["indicesConfig", "refineSearchBox", "getSearchPageURL", "onSelect", "indexUiState", "isSearchPage", "panelComponent", "showRecent", "recentSearchConfig", "showSuggestions", "placeholder"];
 function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 function _toConsumableArray(r) { return _arrayWithoutHoles(r) || _iterableToArray(r) || _unsupportedIterableToArray(r) || _nonIterableSpread(); }
 function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
 function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
@@ -53,6 +53,7 @@ var useStorage = createAutocompleteStorage({
   useState: useState
 });
 export function EXPERIMENTAL_Autocomplete(_ref) {
+  var _showRecent$className, _showRecent$className2, _showRecent$className3, _showRecent$className4;
   var _ref$indices = _ref.indices,
     indices = _ref$indices === void 0 ? [] : _ref$indices,
     showSuggestions = _ref.showSuggestions,
@@ -78,10 +79,12 @@ export function EXPERIMENTAL_Autocomplete(_ref) {
       headerComponent: showSuggestions.headerComponent,
       itemComponent: showSuggestions.itemComponent || function (_ref2) {
         var item = _ref2.item,
-          onSelect = _ref2.onSelect;
+          onSelect = _ref2.onSelect,
+          onApply = _ref2.onApply;
         return /*#__PURE__*/React.createElement(AutocompleteSuggestion, {
           item: item,
-          onSelect: onSelect
+          onSelect: onSelect,
+          onApply: onApply
         }, /*#__PURE__*/React.createElement(ConditionalReverseHighlight, {
           item: item
         }));
@@ -98,6 +101,16 @@ export function EXPERIMENTAL_Autocomplete(_ref) {
       getURL: showSuggestions.getURL
     });
   }
+  var recentSearchConfig = showRecent ? {
+    headerComponent: _typeof(showRecent) === 'object' ? showRecent.headerComponent : undefined,
+    itemComponent: _typeof(showRecent) === 'object' && showRecent.itemComponent ? showRecent.itemComponent : AutocompleteRecentSearch,
+    classNames: {
+      root: cx('ais-AutocompleteRecentSearches', _typeof(showRecent) === 'object' ? (_showRecent$className = showRecent.classNames) === null || _showRecent$className === void 0 ? void 0 : _showRecent$className.root : undefined),
+      list: cx('ais-AutocompleteRecentSearchesList', _typeof(showRecent) === 'object' ? (_showRecent$className2 = showRecent.classNames) === null || _showRecent$className2 === void 0 ? void 0 : _showRecent$className2.list : undefined),
+      header: cx('ais-AutocompleteRecentSearchesHeader', _typeof(showRecent) === 'object' ? (_showRecent$className3 = showRecent.classNames) === null || _showRecent$className3 === void 0 ? void 0 : _showRecent$className3.header : undefined),
+      item: cx('ais-AutocompleteRecentSearchesItem', _typeof(showRecent) === 'object' ? (_showRecent$className4 = showRecent.classNames) === null || _showRecent$className4 === void 0 ? void 0 : _showRecent$className4.item : undefined)
+    }
+  } : undefined;
   var isSearchPage = useMemo(function () {
     return typeof indexRenderState.hits !== 'undefined' || typeof indexRenderState.infiniteHits !== 'undefined';
   }, [indexRenderState]);
@@ -114,6 +127,7 @@ export function EXPERIMENTAL_Autocomplete(_ref) {
     indexUiState: indexUiState,
     isSearchPage: isSearchPage,
     showRecent: showRecent,
+    recentSearchConfig: recentSearchConfig,
     showSuggestions: showSuggestions
   }))));
 }
@@ -126,6 +140,7 @@ function InnerAutocomplete(_ref3) {
     isSearchPage = _ref3.isSearchPage,
     PanelComponent = _ref3.panelComponent,
     showRecent = _ref3.showRecent,
+    recentSearchConfig = _ref3.recentSearchConfig,
     showSuggestions = _ref3.showSuggestions,
     placeholder = _ref3.placeholder,
     props = _objectWithoutProperties(_ref3, _excluded2);
@@ -151,6 +166,9 @@ function InnerAutocomplete(_ref3) {
         refineSearchBox(query);
         storage.onAdd(query);
       },
+      onApply: function onApply(query) {
+        refineAutocomplete(query);
+      },
       onSelect: userOnSelect !== null && userOnSelect !== void 0 ? userOnSelect : function (_ref4) {
         var query = _ref4.query,
           setQuery = _ref4.setQuery,
@@ -173,30 +191,29 @@ function InnerAutocomplete(_ref3) {
     getItemProps = _usePropGetters.getItemProps,
     getPanelProps = _usePropGetters.getPanelProps,
     getRootProps = _usePropGetters.getRootProps;
-  var AutocompleteRecentSearchComponent = _typeof(showRecent) === 'object' && showRecent.itemComponent || AutocompleteRecentSearch;
   var elements = {};
-  if (showRecent) {
-    elements.recent = /*#__PURE__*/React.createElement(AutocompleteIndex
-    // @ts-ignore - there seems to be problems with React.ComponentType and this, but it's actually correct
-    , {
+  if (showRecent && recentSearchConfig) {
+    var RecentSearchItemComponent = recentSearchConfig.itemComponent;
+    elements.recent = /*#__PURE__*/React.createElement(AutocompleteIndex, {
+      HeaderComponent: recentSearchConfig.headerComponent
+      // @ts-ignore - there seems to be problems with React.ComponentType and this, but it's actually correct
+      ,
       ItemComponent: function ItemComponent(_ref5) {
         var item = _ref5.item,
-          onSelect = _ref5.onSelect;
-        return /*#__PURE__*/React.createElement(AutocompleteRecentSearchComponent, {
+          onSelect = _ref5.onSelect,
+          onApply = _ref5.onApply;
+        return /*#__PURE__*/React.createElement(RecentSearchItemComponent, {
           item: item,
           onSelect: onSelect,
           onRemoveRecentSearch: function onRemoveRecentSearch() {
             return storage.onRemove(item.query);
-          }
+          },
+          onApply: onApply
         }, /*#__PURE__*/React.createElement(ConditionalReverseHighlight, {
           item: item
         }));
       },
-      classNames: {
-        root: 'ais-AutocompleteRecentSearches',
-        list: 'ais-AutocompleteRecentSearchesList',
-        item: 'ais-AutocompleteRecentSearchesItem'
-      },
+      classNames: recentSearchConfig.classNames,
       items: storageHits,
       getItemProps: getItemProps,
       key: "recentSearches"