instantsearch.js 4.36.0 → 4.37.3

package/cjs/widgets/rating-menu/rating-menu.js

@@ -9,15 +9,15 @@ var _preact = require("preact");
 
 var _classnames = _interopRequireDefault(require("classnames"));
 
-var _RefinementList = _interopRequireDefault(require("../../components/RefinementList/RefinementList"));
+var _RefinementList = _interopRequireDefault(require("../../components/RefinementList/RefinementList.js"));
 
-var _connectRatingMenu = _interopRequireDefault(require("../../connectors/rating-menu/connectRatingMenu"));
+var _connectRatingMenu = _interopRequireDefault(require("../../connectors/rating-menu/connectRatingMenu.js"));
 
-var _defaultTemplates = _interopRequireDefault(require("./defaultTemplates"));
+var _defaultTemplates = _interopRequireDefault(require("./defaultTemplates.js"));
 
-var _utils = require("../../lib/utils");
+var _index = require("../../lib/utils/index.js");
 
-var _suit = require("../../lib/suit");
+var _suit = require("../../lib/suit.js");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -27,7 +27,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-var withUsage = (0, _utils.createDocumentationMessageGenerator)({
+var withUsage = (0, _index.createDocumentationMessageGenerator)({
   name: 'rating-menu'
 });
 var suit = (0, _suit.component)('RatingMenu');
@@ -52,7 +52,7 @@ var renderer = function renderer(_ref) {
         instantSearchInstance = _ref2.instantSearchInstance;
 
     if (isFirstRendering) {
-      renderState.templateProps = (0, _utils.prepareTemplateProps)({
+      renderState.templateProps = (0, _index.prepareTemplateProps)({
         defaultTemplates: _defaultTemplates.default,
         templatesConfig: instantSearchInstance.templatesConfig,
         templates: templates
@@ -124,7 +124,7 @@ var ratingMenu = function ratingMenu(widgetParams) {
     throw new Error(withUsage('The `container` option is required.'));
   }
 
-  var containerNode = (0, _utils.getContainerNode)(container);
+  var containerNode = (0, _index.getContainerNode)(container);
   var cssClasses = {
     root: (0, _classnames.default)(suit(), userCssClasses.root),
     noRefinementRoot: (0, _classnames.default)(suit({

package/cjs/widgets/refinement-list/refinement-list.js

@@ -9,17 +9,17 @@ var _preact = require("preact");
 
 var _classnames = _interopRequireDefault(require("classnames"));
 
-var _RefinementList = _interopRequireDefault(require("../../components/RefinementList/RefinementList"));
+var _RefinementList = _interopRequireDefault(require("../../components/RefinementList/RefinementList.js"));
 
-var _connectRefinementList = _interopRequireDefault(require("../../connectors/refinement-list/connectRefinementList"));
+var _connectRefinementList = _interopRequireDefault(require("../../connectors/refinement-list/connectRefinementList.js"));
 
-var _utils = require("../../lib/utils");
+var _index = require("../../lib/utils/index.js");
 
-var _suit = require("../../lib/suit");
+var _suit = require("../../lib/suit.js");
 
-var _defaultTemplates = _interopRequireDefault(require("../search-box/defaultTemplates"));
+var _defaultTemplates = _interopRequireDefault(require("../search-box/defaultTemplates.js"));
 
-var _defaultTemplates2 = _interopRequireDefault(require("./defaultTemplates"));
+var _defaultTemplates2 = _interopRequireDefault(require("./defaultTemplates.js"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -29,7 +29,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-var withUsage = (0, _utils.createDocumentationMessageGenerator)({
+var withUsage = (0, _index.createDocumentationMessageGenerator)({
   name: 'refinement-list'
 });
 var suit = (0, _suit.component)('RefinementList');
@@ -58,12 +58,12 @@ var renderer = function renderer(_ref) {
         canToggleShowMore = _ref2.canToggleShowMore;
 
     if (isFirstRendering) {
-      renderState.templateProps = (0, _utils.prepareTemplateProps)({
+      renderState.templateProps = (0, _index.prepareTemplateProps)({
         defaultTemplates: _defaultTemplates2.default,
         templatesConfig: instantSearchInstance.templatesConfig,
         templates: templates
       });
-      renderState.searchBoxTemplateProps = (0, _utils.prepareTemplateProps)({
+      renderState.searchBoxTemplateProps = (0, _index.prepareTemplateProps)({
         defaultTemplates: _defaultTemplates.default,
         templatesConfig: instantSearchInstance.templatesConfig,
         templates: searchBoxTemplates
@@ -138,7 +138,7 @@ var refinementList = function refinementList(widgetParams) {
   }
 
   var escapeFacetValues = searchable ? Boolean(searchableEscapeFacetValues) : false;
-  var containerNode = (0, _utils.getContainerNode)(container);
+  var containerNode = (0, _index.getContainerNode)(container);
   var cssClasses = {
     root: (0, _classnames.default)(suit(), userCssClasses.root),
     noRefinementRoot: (0, _classnames.default)(suit({

package/cjs/widgets/relevant-sort/relevant-sort.js

@@ -9,15 +9,15 @@ var _preact = require("preact");
 
 var _classnames = _interopRequireDefault(require("classnames"));
 
-var _utils = require("../../lib/utils");
+var _index = require("../../lib/utils/index.js");
 
-var _suit = require("../../lib/suit");
+var _suit = require("../../lib/suit.js");
 
-var _connectRelevantSort = _interopRequireDefault(require("../../connectors/relevant-sort/connectRelevantSort"));
+var _connectRelevantSort = _interopRequireDefault(require("../../connectors/relevant-sort/connectRelevantSort.js"));
 
-var _RelevantSort = _interopRequireDefault(require("../../components/RelevantSort/RelevantSort"));
+var _RelevantSort = _interopRequireDefault(require("../../components/RelevantSort/RelevantSort.js"));
 
-var _defaultTemplates = _interopRequireDefault(require("./defaultTemplates"));
+var _defaultTemplates = _interopRequireDefault(require("./defaultTemplates.js"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -27,7 +27,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-var withUsage = (0, _utils.createDocumentationMessageGenerator)({
+var withUsage = (0, _index.createDocumentationMessageGenerator)({
   name: 'relevant-sort'
 });
 var suit = (0, _suit.component)('RelevantSort');
@@ -61,7 +61,7 @@ var relevantSort = function relevantSort(widgetParams) {
     throw new Error(withUsage('The `container` option is required.'));
   }
 
-  var containerNode = (0, _utils.getContainerNode)(container);
+  var containerNode = (0, _index.getContainerNode)(container);
   var cssClasses = {
     root: (0, _classnames.default)(suit(), userCssClasses.root),
     text: (0, _classnames.default)(suit({

package/cjs/widgets/search-box/search-box.js

@@ -9,15 +9,15 @@ var _preact = require("preact");
 
 var _classnames = _interopRequireDefault(require("classnames"));
 
-var _utils = require("../../lib/utils");
+var _index = require("../../lib/utils/index.js");
 
-var _suit = require("../../lib/suit");
+var _suit = require("../../lib/suit.js");
 
-var _connectSearchBox = _interopRequireDefault(require("../../connectors/search-box/connectSearchBox"));
+var _connectSearchBox = _interopRequireDefault(require("../../connectors/search-box/connectSearchBox.js"));
 
-var _SearchBox = _interopRequireDefault(require("../../components/SearchBox/SearchBox"));
+var _SearchBox = _interopRequireDefault(require("../../components/SearchBox/SearchBox.js"));
 
-var _defaultTemplates = _interopRequireDefault(require("./defaultTemplates"));
+var _defaultTemplates = _interopRequireDefault(require("./defaultTemplates.js"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -27,7 +27,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-var withUsage = (0, _utils.createDocumentationMessageGenerator)({
+var withUsage = (0, _index.createDocumentationMessageGenerator)({
   name: 'search-box'
 });
 var suit = (0, _suit.component)('SearchBox');
@@ -96,7 +96,7 @@ var searchBox = function searchBox(widgetParams) {
     throw new Error(withUsage('The `container` option is required.'));
   }
 
-  var containerNode = (0, _utils.getContainerNode)(container);
+  var containerNode = (0, _index.getContainerNode)(container);
   var cssClasses = {
     root: (0, _classnames.default)(suit(), userCssClasses.root),
     form: (0, _classnames.default)(suit({

package/cjs/widgets/sort-by/sort-by.js

@@ -9,13 +9,13 @@ var _preact = require("preact");
 
 var _classnames = _interopRequireDefault(require("classnames"));
 
-var _Selector = _interopRequireDefault(require("../../components/Selector/Selector"));
+var _Selector = _interopRequireDefault(require("../../components/Selector/Selector.js"));
 
-var _connectSortBy = _interopRequireDefault(require("../../connectors/sort-by/connectSortBy"));
+var _connectSortBy = _interopRequireDefault(require("../../connectors/sort-by/connectSortBy.js"));
 
-var _utils = require("../../lib/utils");
+var _index = require("../../lib/utils/index.js");
 
-var _suit = require("../../lib/suit");
+var _suit = require("../../lib/suit.js");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -25,7 +25,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-var withUsage = (0, _utils.createDocumentationMessageGenerator)({
+var withUsage = (0, _index.createDocumentationMessageGenerator)({
   name: 'sort-by'
 });
 var suit = (0, _suit.component)('SortBy');
@@ -70,7 +70,7 @@ var sortBy = function sortBy(widgetParams) {
     throw new Error(withUsage('The `container` option is required.'));
   }
 
-  var containerNode = (0, _utils.getContainerNode)(container);
+  var containerNode = (0, _index.getContainerNode)(container);
   var cssClasses = {
     root: (0, _classnames.default)(suit(), userCssClasses.root),
     select: (0, _classnames.default)(suit({

package/cjs/widgets/stats/defaultTemplates.js

@@ -10,4 +10,4 @@ Object.defineProperty(exports, "default", {
   }
 });
 
-var _stats = require("./stats");
+var _stats = require("./stats.js");

package/cjs/widgets/stats/stats.js

@@ -9,13 +9,13 @@ var _preact = require("preact");
 
 var _classnames = _interopRequireDefault(require("classnames"));
 
-var _Stats = _interopRequireDefault(require("../../components/Stats/Stats"));
+var _Stats = _interopRequireDefault(require("../../components/Stats/Stats.js"));
 
-var _connectStats = _interopRequireDefault(require("../../connectors/stats/connectStats"));
+var _connectStats = _interopRequireDefault(require("../../connectors/stats/connectStats.js"));
 
-var _utils = require("../../lib/utils");
+var _index = require("../../lib/utils/index.js");
 
-var _suit = require("../../lib/suit");
+var _suit = require("../../lib/suit.js");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -25,7 +25,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-var withUsage = (0, _utils.createDocumentationMessageGenerator)({
+var withUsage = (0, _index.createDocumentationMessageGenerator)({
   name: 'stats'
 });
 var suit = (0, _suit.component)('Stats');
@@ -51,7 +51,7 @@ var renderer = function renderer(_ref) {
         instantSearchInstance = _ref2.instantSearchInstance;
 
     if (isFirstRendering) {
-      renderState.templateProps = (0, _utils.prepareTemplateProps)({
+      renderState.templateProps = (0, _index.prepareTemplateProps)({
         defaultTemplates: defaultTemplates,
         templatesConfig: instantSearchInstance.templatesConfig,
         templates: templates
@@ -93,7 +93,7 @@ var stats = function stats(widgetParams) {
     throw new Error(withUsage('The `container` option is required.'));
   }
 
-  var containerNode = (0, _utils.getContainerNode)(container);
+  var containerNode = (0, _index.getContainerNode)(container);
   var cssClasses = {
     root: (0, _classnames.default)(suit(), userCssClasses.root),
     text: (0, _classnames.default)(suit({

package/cjs/widgets/toggle-refinement/toggle-refinement.js

@@ -9,15 +9,15 @@ var _preact = require("preact");
 
 var _classnames = _interopRequireDefault(require("classnames"));
 
-var _ToggleRefinement = _interopRequireDefault(require("../../components/ToggleRefinement/ToggleRefinement"));
+var _ToggleRefinement = _interopRequireDefault(require("../../components/ToggleRefinement/ToggleRefinement.js"));
 
-var _connectToggleRefinement = _interopRequireDefault(require("../../connectors/toggle-refinement/connectToggleRefinement"));
+var _connectToggleRefinement = _interopRequireDefault(require("../../connectors/toggle-refinement/connectToggleRefinement.js"));
 
-var _defaultTemplates = _interopRequireDefault(require("./defaultTemplates"));
+var _defaultTemplates = _interopRequireDefault(require("./defaultTemplates.js"));
 
-var _utils = require("../../lib/utils");
+var _index = require("../../lib/utils/index.js");
 
-var _suit = require("../../lib/suit");
+var _suit = require("../../lib/suit.js");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -27,7 +27,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-var withUsage = (0, _utils.createDocumentationMessageGenerator)({
+var withUsage = (0, _index.createDocumentationMessageGenerator)({
   name: 'toggle-refinement'
 });
 var suit = (0, _suit.component)('ToggleRefinement');
@@ -43,7 +43,7 @@ var renderer = function renderer(_ref) {
         instantSearchInstance = _ref2.instantSearchInstance;
 
     if (isFirstRendering) {
-      renderState.templateProps = (0, _utils.prepareTemplateProps)({
+      renderState.templateProps = (0, _index.prepareTemplateProps)({
         defaultTemplates: _defaultTemplates.default,
         templatesConfig: instantSearchInstance.templatesConfig,
         templates: templates
@@ -88,7 +88,7 @@ var toggleRefinement = function toggleRefinement(widgetParams) {
     throw new Error(withUsage('The `container` option is required.'));
   }
 
-  var containerNode = (0, _utils.getContainerNode)(container);
+  var containerNode = (0, _index.getContainerNode)(container);
   var cssClasses = {
     root: (0, _classnames.default)(suit(), userCssClasses.root),
     label: (0, _classnames.default)(suit({

package/cjs/widgets/voice-search/voice-search.js

@@ -9,15 +9,15 @@ var _preact = require("preact");
 
 var _classnames = _interopRequireDefault(require("classnames"));
 
-var _utils = require("../../lib/utils");
+var _index = require("../../lib/utils/index.js");
 
-var _suit = require("../../lib/suit");
+var _suit = require("../../lib/suit.js");
 
-var _connectVoiceSearch = _interopRequireDefault(require("../../connectors/voice-search/connectVoiceSearch"));
+var _connectVoiceSearch = _interopRequireDefault(require("../../connectors/voice-search/connectVoiceSearch.js"));
 
-var _VoiceSearch = _interopRequireDefault(require("../../components/VoiceSearch/VoiceSearch"));
+var _VoiceSearch = _interopRequireDefault(require("../../components/VoiceSearch/VoiceSearch.js"));
 
-var _defaultTemplates = _interopRequireDefault(require("./defaultTemplates"));
+var _defaultTemplates = _interopRequireDefault(require("./defaultTemplates.js"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -27,7 +27,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-var withUsage = (0, _utils.createDocumentationMessageGenerator)({
+var withUsage = (0, _index.createDocumentationMessageGenerator)({
   name: 'voice-search'
 });
 var suit = (0, _suit.component)('VoiceSearch');
@@ -69,7 +69,7 @@ var voiceSearch = function voiceSearch(widgetParams) {
     throw new Error(withUsage('The `container` option is required.'));
   }
 
-  var containerNode = (0, _utils.getContainerNode)(container);
+  var containerNode = (0, _index.getContainerNode)(container);
   var cssClasses = {
     root: (0, _classnames.default)(suit(), userCssClasses.root),
     button: (0, _classnames.default)(suit({

package/dist/instantsearch.development.d.ts

@@ -4915,7 +4915,9 @@ declare const toggleRefinement: ToggleRefinementWidget;
 declare type ToggleRefinementConnector = Connector<ToggleRefinementWidgetDescription, ToggleRefinementConnectorParams>;
 
 declare type ToggleRefinementConnectorParams = {
-    /** Name of the attribute for faceting (eg. "free_shipping"). */
+    /**
+     * Name of the attribute for faceting (e.g., "free_shipping").
+     */
     attribute: string;
     /**
      * Value to filter on when toggled.
@@ -4950,19 +4952,42 @@ declare type ToggleRefinementCSSClasses = Partial<{
 declare type ToggleRefinementRenderState = {
     /** The current toggle value */
     value: {
+        /**
+         * The attribute name of this toggle.
+         */
         name: string;
+        /**
+         * Whether the current option is "on" (true) or "off" (false)
+         */
         isRefined: boolean;
+        /**
+         * Number of results if this option is toggled.
+         */
         count: number | null;
+        /**
+         * Information about the "on" toggle.
+         */
         onFacetValue: ToggleRefinementValue;
+        /**
+         * Information about the "off" toggle.
+         */
         offFacetValue: ToggleRefinementValue;
     };
-    /** Creates an URL for the next state. */
+    /**
+     * Creates an URL for the next state.
+     */
     createURL: CreateURL<string>;
-    /** send a "facet clicked" insights event */
+    /**
+     * Send a "Facet Clicked" Insights event.
+     */
     sendEvent: SendEventForToggle;
-    /** Indicates if search state can be refined. */
+    /**
+     * Indicates if search state can be refined.
+     */
     canRefine: boolean;
-    /** Updates to the next state by applying the toggle refinement. */
+    /**
+     * Updates to the next state by applying the toggle refinement.
+     */
     refine: (value?: {
         isRefined: boolean;
     }) => void;
@@ -4976,9 +5001,13 @@ declare type ToggleRefinementTemplates = Partial<{
 }>;
 
 declare type ToggleRefinementValue = {
-    /** whether this option is enabled */
+    /**
+     * Whether this option is enabled.
+     */
     isRefined: boolean;
-    /** number of result if this option is enabled */
+    /**
+     * Number of result if this option is toggled.
+     */
     count: number | null;
 };