instantsearch.js 4.54.0 → 4.54.1

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.54.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.54.1 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -11707,6 +11707,10 @@
   };
 
   var suit = component('Highlight');
+
+  /**
+   * @deprecated use html tagged templates and the Highlight component instead
+   */
   function highlight(_ref) {
     var attribute = _ref.attribute,
       _ref$highlightedTagNa = _ref.highlightedTagName,
@@ -11714,6 +11718,7 @@
       hit = _ref.hit,
       _ref$cssClasses = _ref.cssClasses,
       cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+     _warning(false, "`instantsearch.highlight` function has been deprecated. It is still supported in 4.x releases, but not further. It is replaced by the `Highlight` component.\n\nFor more information, visit https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/js/?client=html+tagged+templates#upgrade-templates") ;
     var highlightAttributeResult = getPropertyByPath(hit._highlightResult, attribute);
 
     // @MAJOR fallback to attribute value if highlight is not found
@@ -11730,6 +11735,10 @@
   }
 
   var suit$1 = component('ReverseHighlight');
+
+  /**
+   * @deprecated use html tagged templates and the ReverseHighlight component instead
+   */
   function reverseHighlight(_ref) {
     var attribute = _ref.attribute,
       _ref$highlightedTagNa = _ref.highlightedTagName,
@@ -11737,6 +11746,7 @@
       hit = _ref.hit,
       _ref$cssClasses = _ref.cssClasses,
       cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+     _warning(false, "`instantsearch.reverseHighlight` function has been deprecated. It is still supported in 4.x releases, but not further. It is replaced by the `ReverseHighlight` component.\n\nFor more information, visit https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/js/?client=html+tagged+templates#upgrade-templates") ;
     var highlightAttributeResult = getPropertyByPath(hit._highlightResult, attribute);
 
     // @MAJOR fallback to attribute value if highlight is not found
@@ -11754,6 +11764,10 @@
   }
 
   var suit$2 = component('Snippet');
+
+  /**
+   * @deprecated use html tagged templates and the Snippet component instead
+   */
   function snippet(_ref) {
     var attribute = _ref.attribute,
       _ref$highlightedTagNa = _ref.highlightedTagName,
@@ -11761,6 +11775,7 @@
       hit = _ref.hit,
       _ref$cssClasses = _ref.cssClasses,
       cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+     _warning(false, "`instantsearch.snippet` function has been deprecated. It is still supported in 4.x releases, but not further. It is replaced by the `Snippet` component.\n\nFor more information, visit https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/js/?client=html+tagged+templates#upgrade-templates") ;
     var snippetAttributeResult = getPropertyByPath(hit._snippetResult, attribute);
 
     // @MAJOR fallback to attribute value if snippet is not found
@@ -11777,6 +11792,10 @@
   }
 
   var suit$3 = component('ReverseSnippet');
+
+  /**
+   * @deprecated use html tagged templates and the ReverseSnippet component instead
+   */
   function reverseSnippet(_ref) {
     var attribute = _ref.attribute,
       _ref$highlightedTagNa = _ref.highlightedTagName,
@@ -11784,6 +11803,7 @@
       hit = _ref.hit,
       _ref$cssClasses = _ref.cssClasses,
       cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+     _warning(false, "`instantsearch.reverseSnippet` function has been deprecated. It is still supported in 4.x releases, but not further. It is replaced by the `ReverseSnippet` component.\n\nFor more information, visit https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/js/?client=html+tagged+templates#upgrade-templates") ;
     var snippetAttributeResult = getPropertyByPath(hit._snippetResult, attribute);
 
     // @MAJOR fallback to attribute value if snippet is not found
@@ -13640,7 +13660,7 @@
     };
   }
 
-  var version$1 = '4.54.0';
+  var version$1 = '4.54.1';
 
   var withUsage$r = createDocumentationMessageGenerator({
     name: 'instantsearch'
@@ -15535,9 +15555,12 @@
       key: "render",
       value: function render() {
         var _this = this;
-         _warning(Object.keys(this.props.templates).every(function (key) {
-          return typeof _this.props.templates[key] === 'function';
-        }), "Hogan.js and string-based templates are deprecated and will not be supported in InstantSearch.js 5.x.\n\nYou can replace them with function-form templates and use either the provided `html` function or JSX templates.\n\nSee: https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/js/#upgrade-templates") ;
+        {
+          var nonFunctionTemplates = Object.keys(this.props.templates).filter(function (key) {
+            return typeof _this.props.templates[key] !== 'function';
+          });
+           _warning(nonFunctionTemplates.length === 0, "Hogan.js and string-based templates are deprecated and will not be supported in InstantSearch.js 5.x.\n\nYou can replace them with function-form templates and use either the provided `html` function or JSX templates.\n\nString-based templates: ".concat(nonFunctionTemplates.join(', '), ".\n\nSee: https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/js/#upgrade-templates")) ;
+        }
         var RootTagName = this.props.rootTagName;
         var useCustomCompileOptions = this.props.useCustomCompileOptions[this.props.templateKey];
         var compileOptions = useCustomCompileOptions ? this.props.templatesConfig.compileOptions : {};
@@ -18256,7 +18279,8 @@
       ariaLabel: "First",
       className: props.cssClasses.firstPageItem,
       isDisabled: props.isFirstPage,
-      label: props.templates.first,
+      templates: props.templates,
+      templateKey: "first",
       pageNumber: 0,
       createURL: props.createURL,
       cssClasses: props.cssClasses,
@@ -18265,7 +18289,8 @@
       ariaLabel: "Previous",
       className: props.cssClasses.previousPageItem,
       isDisabled: props.isFirstPage,
-      label: props.templates.previous,
+      templates: props.templates,
+      templateKey: "previous",
       pageNumber: props.currentPage - 1,
       createURL: props.createURL,
       cssClasses: props.cssClasses,
@@ -18276,7 +18301,8 @@
         ariaLabel: "Page ".concat(pageNumber + 1),
         className: props.cssClasses.pageItem,
         isSelected: pageNumber === props.currentPage,
-        label: "".concat(pageNumber + 1),
+        templates: props.templates,
+        templateKey: "page",
         pageNumber: pageNumber,
         createURL: props.createURL,
         cssClasses: props.cssClasses,
@@ -18286,7 +18312,8 @@
       ariaLabel: "Next",
       className: props.cssClasses.nextPageItem,
       isDisabled: props.isLastPage,
-      label: props.templates.next,
+      templates: props.templates,
+      templateKey: "next",
       pageNumber: props.currentPage + 1,
       createURL: props.createURL,
       cssClasses: props.cssClasses,
@@ -18295,7 +18322,8 @@
       ariaLabel: "Last",
       className: props.cssClasses.lastPageItem,
       isDisabled: props.isLastPage,
-      label: props.templates.last,
+      templates: props.templates,
+      templateKey: "last",
       pageNumber: props.nbPages - 1,
       createURL: props.createURL,
       cssClasses: props.cssClasses,
@@ -18303,7 +18331,8 @@
     })));
   }
   function PaginationLink(_ref) {
-    var label = _ref.label,
+    var templates = _ref.templates,
+      templateKey = _ref.templateKey,
       ariaLabel = _ref.ariaLabel,
       pageNumber = _ref.pageNumber,
       className = _ref.className,
@@ -18316,18 +18345,28 @@
       createClickHandler = _ref.createClickHandler;
     return h("li", {
       className: cx(cssClasses.item, className, isDisabled && cssClasses.disabledItem, isSelected && cssClasses.selectedItem)
-    }, isDisabled ? h("span", {
-      className: cssClasses.link,
-      dangerouslySetInnerHTML: {
-        __html: label
+    }, isDisabled ? h(Template, {
+      rootTagName: "span",
+      rootProps: {
+        className: cssClasses.link
+      },
+      templateKey: templateKey,
+      templates: templates,
+      data: {
+        page: pageNumber + 1
       }
-    }) : h("a", {
-      className: cssClasses.link,
-      "aria-label": ariaLabel,
-      href: createURL(pageNumber),
-      onClick: createClickHandler(pageNumber),
-      dangerouslySetInnerHTML: {
-        __html: label
+    }) : h(Template, {
+      rootTagName: "a",
+      rootProps: {
+        className: cssClasses.link,
+        'aria-label': ariaLabel,
+        href: createURL(pageNumber),
+        onClick: createClickHandler(pageNumber)
+      },
+      templateKey: templateKey,
+      templates: templates,
+      data: {
+        page: pageNumber + 1
       }
     }));
   }
@@ -18337,28 +18376,40 @@
     name: 'pagination'
   });
   var defaultTemplates$a = {
-    previous: '‹',
-    next: '›',
-    first: '«',
-    last: '»'
+    previous: function previous() {
+      return '‹';
+    },
+    next: function next() {
+      return '›';
+    },
+    page: function page(_ref) {
+      var _page = _ref.page;
+      return "".concat(_page);
+    },
+    first: function first() {
+      return '«';
+    },
+    last: function last() {
+      return '»';
+    }
   };
-  var renderer$c = function renderer(_ref) {
-    var containerNode = _ref.containerNode,
-      cssClasses = _ref.cssClasses,
-      templates = _ref.templates,
-      showFirst = _ref.showFirst,
-      showLast = _ref.showLast,
-      showPrevious = _ref.showPrevious,
-      showNext = _ref.showNext,
-      scrollToNode = _ref.scrollToNode;
-    return function (_ref2, isFirstRendering) {
-      var createURL = _ref2.createURL,
-        currentRefinement = _ref2.currentRefinement,
-        nbPages = _ref2.nbPages,
-        pages = _ref2.pages,
-        isFirstPage = _ref2.isFirstPage,
-        isLastPage = _ref2.isLastPage,
-        refine = _ref2.refine;
+  var renderer$c = function renderer(_ref2) {
+    var containerNode = _ref2.containerNode,
+      cssClasses = _ref2.cssClasses,
+      templates = _ref2.templates,
+      showFirst = _ref2.showFirst,
+      showLast = _ref2.showLast,
+      showPrevious = _ref2.showPrevious,
+      showNext = _ref2.showNext,
+      scrollToNode = _ref2.scrollToNode;
+    return function (_ref3, isFirstRendering) {
+      var createURL = _ref3.createURL,
+        currentRefinement = _ref3.currentRefinement,
+        nbPages = _ref3.nbPages,
+        pages = _ref3.pages,
+        isFirstPage = _ref3.isFirstPage,
+        isLastPage = _ref3.isLastPage,
+        refine = _ref3.refine;
       if (isFirstRendering) return;
       var setCurrentPage = function setCurrentPage(pageNumber) {
         refine(pageNumber);
@@ -18384,24 +18435,24 @@
     };
   };
   var pagination = function pagination(widgetParams) {
-    var _ref3 = widgetParams || {},
-      container = _ref3.container,
-      _ref3$templates = _ref3.templates,
-      userTemplates = _ref3$templates === void 0 ? {} : _ref3$templates,
-      _ref3$cssClasses = _ref3.cssClasses,
-      userCssClasses = _ref3$cssClasses === void 0 ? {} : _ref3$cssClasses,
-      totalPages = _ref3.totalPages,
-      padding = _ref3.padding,
-      _ref3$showFirst = _ref3.showFirst,
-      showFirst = _ref3$showFirst === void 0 ? true : _ref3$showFirst,
-      _ref3$showLast = _ref3.showLast,
-      showLast = _ref3$showLast === void 0 ? true : _ref3$showLast,
-      _ref3$showPrevious = _ref3.showPrevious,
-      showPrevious = _ref3$showPrevious === void 0 ? true : _ref3$showPrevious,
-      _ref3$showNext = _ref3.showNext,
-      showNext = _ref3$showNext === void 0 ? true : _ref3$showNext,
-      _ref3$scrollTo = _ref3.scrollTo,
-      userScrollTo = _ref3$scrollTo === void 0 ? 'body' : _ref3$scrollTo;
+    var _ref4 = widgetParams || {},
+      container = _ref4.container,
+      _ref4$templates = _ref4.templates,
+      userTemplates = _ref4$templates === void 0 ? {} : _ref4$templates,
+      _ref4$cssClasses = _ref4.cssClasses,
+      userCssClasses = _ref4$cssClasses === void 0 ? {} : _ref4$cssClasses,
+      totalPages = _ref4.totalPages,
+      padding = _ref4.padding,
+      _ref4$showFirst = _ref4.showFirst,
+      showFirst = _ref4$showFirst === void 0 ? true : _ref4$showFirst,
+      _ref4$showLast = _ref4.showLast,
+      showLast = _ref4$showLast === void 0 ? true : _ref4$showLast,
+      _ref4$showPrevious = _ref4.showPrevious,
+      showPrevious = _ref4$showPrevious === void 0 ? true : _ref4$showPrevious,
+      _ref4$showNext = _ref4.showNext,
+      showNext = _ref4$showNext === void 0 ? true : _ref4$showNext,
+      _ref4$scrollTo = _ref4.scrollTo,
+      userScrollTo = _ref4$scrollTo === void 0 ? 'body' : _ref4$scrollTo;
     if (!container) {
       throw new Error(withUsage$G('The `container` option is required.'));
     }
@@ -18619,8 +18670,6 @@
         }
         var containerNode = getContainerNode(widgetParams.container);
         var defaultTemplates = {
-          header: '',
-          footer: '',
           collapseButtonText: function collapseButtonText(_ref4) {
             var isCollapsed = _ref4.collapsed;
             return "<svg\n          class=\"".concat(cssClasses.collapseIcon, "\"\n          style=\"width: 1em; height: 1em;\"\n          viewBox=\"0 0 500 500\"\n        >\n        <path d=\"").concat(isCollapsed ? 'M100 250l300-150v300z' : 'M250 400l150-300H100z', "\" fill=\"currentColor\" />\n        </svg>");