@algolia/autocomplete-js 1.6.1 → 1.7.0

package/dist/umd/index.development.js

@@ -1,4 +1,4 @@
-/*! @algolia/autocomplete-js 1.6.1 | MIT License | © Algolia, Inc. and contributors | https://github.com/algolia/autocomplete */
+/*! @algolia/autocomplete-js 1.7.0 | MIT License | © Algolia, Inc. and contributors | https://github.com/algolia/autocomplete */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
   typeof define === 'function' && define.amd ? define(['exports'], factory) :
@@ -110,6 +110,10 @@
     return target;
   }
 
+  function _slicedToArray$1(arr, i) {
+    return _arrayWithHoles$1(arr) || _iterableToArrayLimit$1(arr, i) || _unsupportedIterableToArray$6(arr, i) || _nonIterableRest$1();
+  }
+
   function _toConsumableArray$5(arr) {
     return _arrayWithoutHoles$5(arr) || _iterableToArray$5(arr) || _unsupportedIterableToArray$6(arr) || _nonIterableSpread$5();
   }
@@ -118,10 +122,44 @@
     if (Array.isArray(arr)) return _arrayLikeToArray$6(arr);
   }
 
+  function _arrayWithHoles$1(arr) {
+    if (Array.isArray(arr)) return arr;
+  }
+
   function _iterableToArray$5(iter) {
     if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
   }
 
+  function _iterableToArrayLimit$1(arr, i) {
+    var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"];
+
+    if (_i == null) return;
+    var _arr = [];
+    var _n = true;
+    var _d = false;
+
+    var _s, _e;
+
+    try {
+      for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) {
+        _arr.push(_s.value);
+
+        if (i && _arr.length === i) break;
+      }
+    } catch (err) {
+      _d = true;
+      _e = err;
+    } finally {
+      try {
+        if (!_n && _i["return"] != null) _i["return"]();
+      } finally {
+        if (_d) throw _e;
+      }
+    }
+
+    return _arr;
+  }
+
   function _unsupportedIterableToArray$6(o, minLen) {
     if (!o) return;
     if (typeof o === "string") return _arrayLikeToArray$6(o, minLen);
@@ -143,6 +181,10 @@
     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 _nonIterableRest$1() {
+    throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+  }
+
   function createRef(initialValue) {
     return {
       current: initialValue
@@ -311,7 +353,7 @@
 
   var noop = function noop() {};
 
-  var version = '1.6.1';
+  var version = '1.7.0';
 
   var userAgents$1 = [{
     segment: 'autocomplete-core',
@@ -1354,7 +1396,7 @@
     });
   }
 
-  var _excluded$6 = ["event", "nextState", "props", "query", "refresh", "store"];
+  var _excluded$7 = ["event", "nextState", "props", "query", "refresh", "store"];
 
   function ownKeys$8(object, enumerableOnly) {
     var keys = Object.keys(object);
@@ -1442,7 +1484,7 @@
         query = _ref.query,
         refresh = _ref.refresh,
         store = _ref.store,
-        setters = _objectWithoutProperties$3(_ref, _excluded$6);
+        setters = _objectWithoutProperties$3(_ref, _excluded$7);
 
     if (lastStalledId) {
       props.environment.clearTimeout(lastStalledId);
@@ -1552,7 +1594,7 @@
     return store.pendingRequests.add(request);
   }
 
-  var _excluded$5 = ["event", "props", "refresh", "store"];
+  var _excluded$6 = ["event", "props", "refresh", "store"];
 
   function ownKeys$7(object, enumerableOnly) {
     var keys = Object.keys(object);
@@ -1635,7 +1677,7 @@
         props = _ref.props,
         refresh = _ref.refresh,
         store = _ref.store,
-        setters = _objectWithoutProperties$2(_ref, _excluded$5);
+        setters = _objectWithoutProperties$2(_ref, _excluded$6);
 
     if (event.key === 'ArrowUp' || event.key === 'ArrowDown') {
       // eslint-disable-next-line no-inner-declarations
@@ -1709,6 +1751,13 @@
       // pending and could reopen the panel once they resolve, because that would
       // result in an unsolicited UI behavior.
 
+      store.pendingRequests.cancelAll();
+    } else if (event.key === 'Tab') {
+      store.dispatch('blur', null); // Hitting the `Escape` key signals the end of a user interaction with the
+      // autocomplete. At this point, we should ignore any requests that are still
+      // pending and could reopen the panel once they resolve, because that would
+      // result in an unsolicited UI behavior.
+
       store.pendingRequests.cancelAll();
     } else if (event.key === 'Enter') {
       // No active item, so we let the browser handle the native `onSubmit` form
@@ -1716,6 +1765,14 @@
       if (store.getState().activeItemId === null || store.getState().collections.every(function (collection) {
         return collection.items.length === 0;
       })) {
+        // If requests are still pending when the panel closes, they could reopen
+        // the panel once they resolve.
+        // We want to prevent any subsequent query from reopening the panel
+        // because it would result in an unsolicited UI behavior.
+        if (!props.debug) {
+          store.pendingRequests.cancelAll();
+        }
+
         return;
       } // This prevents the `onSubmit` event to be sent because an item is
       // highlighted.
@@ -1806,7 +1863,7 @@
     }
   }
 
-  var _excluded$4 = ["props", "refresh", "store"],
+  var _excluded$5 = ["props", "refresh", "store"],
       _excluded2 = ["inputElement", "formElement", "panelElement"],
       _excluded3 = ["inputElement"],
       _excluded4 = ["inputElement", "maxLength"],
@@ -1892,7 +1949,7 @@
     var props = _ref.props,
         refresh = _ref.refresh,
         store = _ref.store,
-        setters = _objectWithoutProperties$1(_ref, _excluded$4);
+        setters = _objectWithoutProperties$1(_ref, _excluded$5);
 
     var getEnvironmentProps = function getEnvironmentProps(providedProps) {
       var inputElement = providedProps.inputElement,
@@ -1900,42 +1957,49 @@
           panelElement = providedProps.panelElement,
           rest = _objectWithoutProperties$1(providedProps, _excluded2);
 
-      return _objectSpread$6({
-        // On touch devices, we do not rely on the native `blur` event of the
-        // input to close the panel, but rather on a custom `touchstart` event
-        // outside of the autocomplete elements.
-        // This ensures a working experience on mobile because we blur the input
-        // on touch devices when the user starts scrolling (`touchmove`).
-        // @TODO: support cases where there are multiple Autocomplete instances.
+      function onMouseDownOrTouchStart(event) {
+        // The `onTouchStart`/`onMouseDown` events shouldn't trigger the `blur`
+        // handler when it's not an interaction with Autocomplete.
+        // We detect it with the following heuristics:
+        // - the panel is closed AND there are no pending requests
+        //   (no interaction with the autocomplete, no future state updates)
+        // - OR the touched target is the input element (should open the panel)
+        var isAutocompleteInteraction = store.getState().isOpen || !store.pendingRequests.isEmpty();
+
+        if (!isAutocompleteInteraction || event.target === inputElement) {
+          return;
+        } // @TODO: support cases where there are multiple Autocomplete instances.
         // Right now, a second instance makes this computation return false.
-        onTouchStart: function onTouchStart(event) {
-          // The `onTouchStart` event shouldn't trigger the `blur` handler when
-          // it's not an interaction with Autocomplete. We detect it with the
-          // following heuristics:
-          // - the panel is closed AND there are no pending requests
-          //   (no interaction with the autocomplete, no future state updates)
-          // - OR the touched target is the input element (should open the panel)
-          var isAutocompleteInteraction = store.getState().isOpen || !store.pendingRequests.isEmpty();
-
-          if (!isAutocompleteInteraction || event.target === inputElement) {
-            return;
-          }
 
-          var isTargetWithinAutocomplete = [formElement, panelElement].some(function (contextNode) {
-            return isOrContainsNode(contextNode, event.target);
-          });
 
-          if (isTargetWithinAutocomplete === false) {
-            store.dispatch('blur', null); // If requests are still pending when the user closes the panel, they
-            // could reopen the panel once they resolve.
-            // We want to prevent any subsequent query from reopening the panel
-            // because it would result in an unsolicited UI behavior.
+        var isTargetWithinAutocomplete = [formElement, panelElement].some(function (contextNode) {
+          return isOrContainsNode(contextNode, event.target);
+        });
 
-            if (!props.debug) {
-              store.pendingRequests.cancelAll();
-            }
+        if (isTargetWithinAutocomplete === false) {
+          store.dispatch('blur', null); // If requests are still pending when the user closes the panel, they
+          // could reopen the panel once they resolve.
+          // We want to prevent any subsequent query from reopening the panel
+          // because it would result in an unsolicited UI behavior.
+
+          if (!props.debug) {
+            store.pendingRequests.cancelAll();
           }
-        },
+        }
+      }
+
+      return _objectSpread$6({
+        // We do not rely on the native `blur` event of the input to close the
+        // panel, but rather on a custom `touchstart`/`mousedown` event outside
+        // of the autocomplete elements.
+        // This ensures we don't mistakenly interpret interactions within the
+        // autocomplete (but outside of the input) as a signal to close the panel.
+        // For example, clicking reset button causes an input blur, but if
+        // `openOnFocus=true`, it shouldn't close the panel.
+        // On touch devices, scrolling results (`touchmove`) causes an input blur
+        // but shouldn't close the panel.
+        onTouchStart: onMouseDownOrTouchStart,
+        onMouseDown: onMouseDownOrTouchStart,
         // When scrolling on touch devices (mobiles, tablets, etc.), we want to
         // mimic the native platform behavior where the input is blurred to
         // hide the virtual keyboard. This gives more vertical space to
@@ -2014,8 +2078,6 @@
         store.dispatch('focus', null);
       }
 
-      var isTouchDevice = ('ontouchstart' in props.environment);
-
       var _ref2 = providedProps || {};
           _ref2.inputElement;
           var _ref2$maxLength = _ref2.maxLength,
@@ -2060,20 +2122,10 @@
           }, setters));
         },
         onFocus: onFocus,
-        onBlur: function onBlur() {
-          // We do rely on the `blur` event on touch devices.
-          // See explanation in `onTouchStart`.
-          if (!isTouchDevice) {
-            store.dispatch('blur', null); // If requests are still pending when the user closes the panel, they
-            // could reopen the panel once they resolve.
-            // We want to prevent any subsequent query from reopening the panel
-            // because it would result in an unsolicited UI behavior.
-
-            if (!props.debug) {
-              store.pendingRequests.cancelAll();
-            }
-          }
-        },
+        // We don't rely on the `blur` event.
+        // See explanation in `onTouchStart`/`onMouseDown`.
+        // @MAJOR See if we need to keep this handler.
+        onBlur: noop,
         onClick: function onClick(event) {
           // When the panel is closed and you click on the input while
           // the input is focused, the `onFocus` event is not triggered
@@ -2667,6 +2719,23 @@
     }, {});
   }
 
+  function pickBy(obj, predicate) {
+    return Object.entries(obj).reduce(function (acc, _ref) {
+      var _ref2 = _slicedToArray$1(_ref, 2),
+          key = _ref2[0],
+          value = _ref2[1];
+
+      if (predicate({
+        key: key,
+        value: value
+      })) {
+        return _objectSpread2(_objectSpread2({}, acc), {}, _defineProperty$g({}, key, value));
+      }
+
+      return acc;
+    }, {});
+  }
+
   /* eslint-disable */
 
   /**
@@ -2778,12 +2847,12 @@
     }
   }
 
-  var _excluded$3 = ["children"];
+  var _excluded$4 = ["children"];
   function getCreateDomElement(environment) {
     return function createDomElement(tagName, _ref) {
       var _ref$children = _ref.children,
           children = _ref$children === void 0 ? [] : _ref$children,
-          props = _objectWithoutProperties$4(_ref, _excluded$3);
+          props = _objectWithoutProperties$4(_ref, _excluded$4);
 
       var element = environment.document.createElement(tagName);
       setProperties(element, props);
@@ -2792,16 +2861,16 @@
     };
   }
 
-  var _excluded$2 = ["autocompleteScopeApi", "environment", "classNames", "getInputProps", "getInputPropsCore", "onDetachedEscape", "state"];
+  var _excluded$3 = ["autocompleteScopeApi", "environment", "classNames", "getInputProps", "getInputPropsCore", "isDetached", "state"];
   var Input = function Input(_ref) {
     var autocompleteScopeApi = _ref.autocompleteScopeApi,
         environment = _ref.environment;
         _ref.classNames;
         var getInputProps = _ref.getInputProps,
         getInputPropsCore = _ref.getInputPropsCore,
-        onDetachedEscape = _ref.onDetachedEscape,
+        isDetached = _ref.isDetached,
         state = _ref.state,
-        props = _objectWithoutProperties$4(_ref, _excluded$2);
+        props = _objectWithoutProperties$4(_ref, _excluded$3);
 
     var createDomElement = getCreateDomElement(environment);
     var element = createDomElement('input', props);
@@ -2814,9 +2883,8 @@
     }, autocompleteScopeApi));
     setProperties(element, _objectSpread2(_objectSpread2({}, inputProps), {}, {
       onKeyDown: function onKeyDown(event) {
-        if (onDetachedEscape && event.key === 'Escape') {
-          event.preventDefault();
-          onDetachedEscape();
+        // In detached mode we don't want to close the panel when hittin `Tab`.
+        if (isDetached && event.key === 'Tab') {
           return;
         }
 
@@ -2922,10 +2990,7 @@
       getInputProps: propGetters.getInputProps,
       getInputPropsCore: autocomplete.getInputProps,
       autocompleteScopeApi: autocompleteScopeApi,
-      onDetachedEscape: isDetached ? function () {
-        autocomplete.setIsOpen(false);
-        setIsModalOpen(false);
-      } : undefined
+      isDetached: isDetached
     });
     var inputWrapperPrefix = createDomElement('div', {
       class: classNames.inputWrapperPrefix,
@@ -3408,7 +3473,7 @@
     };
   }
 
-  var _excluded$1 = ["params"];
+  var _excluded$2 = ["params"];
 
   function ownKeys(object, enumerableOnly) {
     var keys = Object.keys(object);
@@ -3538,7 +3603,7 @@
 
     return searchClient.search(queries.map(function (searchParameters) {
       var params = searchParameters.params,
-          headers = _objectWithoutProperties(searchParameters, _excluded$1);
+          headers = _objectWithoutProperties(searchParameters, _excluded$2);
 
       return _objectSpread(_objectSpread({}, headers), {}, {
         params: _objectSpread({
@@ -3555,7 +3620,8 @@
   function createHighlightComponent(_ref) {
     var createElement = _ref.createElement,
         Fragment = _ref.Fragment;
-    return function Highlight(_ref2) {
+
+    function Highlight(_ref2) {
       var hit = _ref2.hit,
           attribute = _ref2.attribute,
           _ref2$tagName = _ref2.tagName,
@@ -3568,13 +3634,17 @@
           key: index
         }, x.value) : x.value;
       }));
-    };
+    }
+
+    Highlight.__autocomplete_componentName = 'Highlight';
+    return Highlight;
   }
 
   function createReverseHighlightComponent(_ref) {
     var createElement = _ref.createElement,
         Fragment = _ref.Fragment;
-    return function ReverseHighlight(_ref2) {
+
+    function ReverseHighlight(_ref2) {
       var hit = _ref2.hit,
           attribute = _ref2.attribute,
           _ref2$tagName = _ref2.tagName,
@@ -3587,13 +3657,17 @@
           key: index
         }, x.value) : x.value;
       }));
-    };
+    }
+
+    ReverseHighlight.__autocomplete_componentName = 'ReverseHighlight';
+    return ReverseHighlight;
   }
 
   function createReverseSnippetComponent(_ref) {
     var createElement = _ref.createElement,
         Fragment = _ref.Fragment;
-    return function ReverseSnippet(_ref2) {
+
+    function ReverseSnippet(_ref2) {
       var hit = _ref2.hit,
           attribute = _ref2.attribute,
           _ref2$tagName = _ref2.tagName,
@@ -3606,13 +3680,17 @@
           key: index
         }, x.value) : x.value;
       }));
-    };
+    }
+
+    ReverseSnippet.__autocomplete_componentName = 'ReverseSnippet';
+    return ReverseSnippet;
   }
 
   function createSnippetComponent(_ref) {
     var createElement = _ref.createElement,
         Fragment = _ref.Fragment;
-    return function Snippet(_ref2) {
+
+    function Snippet(_ref2) {
       var hit = _ref2.hit,
           attribute = _ref2.attribute,
           _ref2$tagName = _ref2.tagName,
@@ -3625,10 +3703,13 @@
           key: index
         }, x.value) : x.value;
       }));
-    };
+    }
+
+    Snippet.__autocomplete_componentName = 'Snippet';
+    return Snippet;
   }
 
-  var _excluded = ["classNames", "container", "getEnvironmentProps", "getFormProps", "getInputProps", "getItemProps", "getLabelProps", "getListProps", "getPanelProps", "getRootProps", "panelContainer", "panelPlacement", "render", "renderNoResults", "renderer", "detachedMediaQuery", "components", "translations"];
+  var _excluded$1 = ["classNames", "container", "getEnvironmentProps", "getFormProps", "getInputProps", "getItemProps", "getLabelProps", "getListProps", "getPanelProps", "getRootProps", "panelContainer", "panelPlacement", "render", "renderNoResults", "renderer", "detachedMediaQuery", "components", "translations"];
   var defaultClassNames = {
     clearButton: 'aa-ClearButton',
     detachedCancelButton: 'aa-DetachedCancelButton',
@@ -3689,7 +3770,7 @@
         detachedMediaQuery = options.detachedMediaQuery,
         components = options.components,
         translations = options.translations,
-        core = _objectWithoutProperties$4(options, _excluded);
+        core = _objectWithoutProperties$4(options, _excluded$1);
     /* eslint-disable no-restricted-globals */
 
 
@@ -3698,7 +3779,7 @@
 
     var containerElement = getHTMLElement(environment, container);
     invariant(containerElement.tagName !== 'INPUT', 'The `container` option does not support `input` elements. You need to change the container to a `div`.');
-    "development" !== 'production' ? warn(Boolean(!render || (renderer === null || renderer === void 0 ? void 0 : renderer.render)), "You provided the `render` option but did not provide a `renderer.render`. Since v1.6.0, you can provide a `render` function directly in `renderer`." + "\nTo get rid of this warning, do any of the following depending on your use case." + "\n- If you are using the `render` option only to override Autocomplete's default `render` function, pass the `render` function into `renderer` and remove the `render` option." + '\n- If you are using the `render` option to customize the layout, pass your `render` function into `renderer` and use it from the provided parameters of the `render` option.' + '\nSee https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-render') : void 0;
+    "development" !== 'production' ? warn(!(render && renderer && !(renderer !== null && renderer !== void 0 && renderer.render)), "You provided the `render` option but did not provide a `renderer.render`. Since v1.6.0, you can provide a `render` function directly in `renderer`." + "\nTo get rid of this warning, do any of the following depending on your use case." + "\n- If you are using the `render` option only to override Autocomplete's default `render` function, pass the `render` function into `renderer` and remove the `render` option." + '\n- If you are using the `render` option to customize the layout, pass your `render` function into `renderer` and use it from the provided parameters of the `render` option.' + '\n- If you are using the `render` option to work with React 18, pass an empty `render` function into `renderer`.' + '\nSee https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-render') : void 0;
     "development" !== 'production' ? warn(!renderer || render || renderer.Fragment && renderer.createElement && renderer.render, "You provided an incomplete `renderer` (missing: ".concat([!(renderer !== null && renderer !== void 0 && renderer.createElement) && '`renderer.createElement`', !(renderer !== null && renderer !== void 0 && renderer.Fragment) && '`renderer.Fragment`', !(renderer !== null && renderer !== void 0 && renderer.render) && '`renderer.render`'].filter(Boolean).join(', '), "). This can cause rendering issues.") + '\nSee https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-renderer') : void 0;
 
     var defaultedRenderer = _objectSpread2(_objectSpread2({}, defaultRenderer), renderer);
@@ -3969,6 +4050,7 @@
     version: version
   }];
 
+  var _excluded = ["components"];
   function autocomplete(options) {
     var _createEffectWrapper = createEffectWrapper(),
         runEffect = _createEffectWrapper.runEffect,
@@ -4227,7 +4309,21 @@
     function update() {
       var updatedOptions = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
       cleanupEffects();
-      optionsRef.current = mergeDeep(props.value.renderer, props.value.core, {
+
+      var _props$value$renderer = props.value.renderer,
+          components = _props$value$renderer.components,
+          rendererProps = _objectWithoutProperties$4(_props$value$renderer, _excluded);
+
+      optionsRef.current = mergeDeep(rendererProps, props.value.core, {
+        // We need to filter out default components so they can be replaced with
+        // a new `renderer`, without getting rid of user components.
+        // @MAJOR Deal with registering components with the same name as the
+        // default ones. If we disallow overriding default components, we'd just
+        // need to pass all `components` here.
+        components: pickBy(components, function (_ref4) {
+          var value = _ref4.value;
+          return !value.hasOwnProperty('__autocomplete_componentName');
+        }),
         initialState: lastStateRef.current
       }, updatedOptions);
       runReactives();