instantsearch.js 4.35.0 → 4.37.2

package/dist/instantsearch.development.min.d.ts

@@ -1101,6 +1101,20 @@ declare type DynamicWidgetsConnectorParams = {
     transformItems?(items: string[], metadata: {
         results: SearchResults;
     }): string[];
+    /**
+     * To prevent unneeded extra network requests when widgets mount or unmount,
+     * we request all facet values.
+     *
+     * @default ['*']
+     */
+    facets?: ['*'] | never[];
+    /**
+     * If you have more than 20 facet values pinned, you need to increase the
+     * maxValuesPerFacet to at least that value.
+     *
+     * @default 20
+     */
+    maxValuesPerFacet?: number;
 };
 
 declare type DynamicWidgetsRenderState = {
@@ -4901,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.
@@ -4936,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;
@@ -4962,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;
 };
 

package/dist/instantsearch.production.d.ts

@@ -1101,6 +1101,20 @@ declare type DynamicWidgetsConnectorParams = {
     transformItems?(items: string[], metadata: {
         results: SearchResults;
     }): string[];
+    /**
+     * To prevent unneeded extra network requests when widgets mount or unmount,
+     * we request all facet values.
+     *
+     * @default ['*']
+     */
+    facets?: ['*'] | never[];
+    /**
+     * If you have more than 20 facet values pinned, you need to increase the
+     * maxValuesPerFacet to at least that value.
+     *
+     * @default 20
+     */
+    maxValuesPerFacet?: number;
 };
 
 declare type DynamicWidgetsRenderState = {
@@ -4901,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.
@@ -4936,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;
@@ -4962,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;
 };
 

package/dist/instantsearch.production.min.d.ts

@@ -1101,6 +1101,20 @@ declare type DynamicWidgetsConnectorParams = {
     transformItems?(items: string[], metadata: {
         results: SearchResults;
     }): string[];
+    /**
+     * To prevent unneeded extra network requests when widgets mount or unmount,
+     * we request all facet values.
+     *
+     * @default ['*']
+     */
+    facets?: ['*'] | never[];
+    /**
+     * If you have more than 20 facet values pinned, you need to increase the
+     * maxValuesPerFacet to at least that value.
+     *
+     * @default 20
+     */
+    maxValuesPerFacet?: number;
 };
 
 declare type DynamicWidgetsRenderState = {
@@ -4901,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.
@@ -4936,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;
@@ -4962,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;
 };