instantsearch.js 4.57.0 → 4.58.0

package/dist/instantsearch.production.d.ts

@@ -2363,6 +2363,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     indexName: string;
     insightsClient: InsightsClient | null;
     onStateChange: InstantSearchOptions<TUiState>['onStateChange'] | null;
+    future: NonNullable<InstantSearchOptions<TUiState>['future']>;
     helper: AlgoliaSearchHelper | null;
     mainHelper: AlgoliaSearchHelper | null;
     mainIndex: IndexWidget;
@@ -2604,6 +2605,18 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * @deprecated This property will be still supported in 4.x releases, but not further. It is replaced by the `insights` middleware. For more information, visit https://www.algolia.com/doc/guides/getting-insights-and-analytics/search-analytics/click-through-and-conversions/how-to/send-click-and-conversion-events-with-instantsearch/js/
      */
     insightsClient?: InsightsClient;
+    future?: {
+        /**
+         * Changes the way `dispose` is used in InstantSearch lifecycle.
+         *
+         * If `false` (by default), each widget unmounting will remove its state as well, even if there are multiple widgets reading that UI State.
+         *
+         * If `true`, each widget unmounting will only remove its own state if it's the last of its type. This allows for dynamically adding and removing widgets without losing their state.
+         *
+         * @default false
+         */
+        preserveSharedStateOnUnmount?: boolean;
+    };
 };
 
 declare type InstantSearchStatus = 'idle' | 'loading' | 'stalled' | 'error';

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

@@ -2363,6 +2363,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     indexName: string;
     insightsClient: InsightsClient | null;
     onStateChange: InstantSearchOptions<TUiState>['onStateChange'] | null;
+    future: NonNullable<InstantSearchOptions<TUiState>['future']>;
     helper: AlgoliaSearchHelper | null;
     mainHelper: AlgoliaSearchHelper | null;
     mainIndex: IndexWidget;
@@ -2604,6 +2605,18 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * @deprecated This property will be still supported in 4.x releases, but not further. It is replaced by the `insights` middleware. For more information, visit https://www.algolia.com/doc/guides/getting-insights-and-analytics/search-analytics/click-through-and-conversions/how-to/send-click-and-conversion-events-with-instantsearch/js/
      */
     insightsClient?: InsightsClient;
+    future?: {
+        /**
+         * Changes the way `dispose` is used in InstantSearch lifecycle.
+         *
+         * If `false` (by default), each widget unmounting will remove its state as well, even if there are multiple widgets reading that UI State.
+         *
+         * If `true`, each widget unmounting will only remove its own state if it's the last of its type. This allows for dynamically adding and removing widgets without losing their state.
+         *
+         * @default false
+         */
+        preserveSharedStateOnUnmount?: boolean;
+    };
 };
 
 declare type InstantSearchStatus = 'idle' | 'loading' | 'stalled' | 'error';