instantsearch.js 4.79.2 → 4.80.0

package/dist/instantsearch.production.d.ts

@@ -4758,8 +4758,8 @@ declare type IndexWidget<TUiState extends UiState = UiState> = Omit<Widget<Index
     getParent: () => IndexWidget | null;
     getWidgets: () => Array<Widget | IndexWidget>;
     createURL: (nextState: SearchParameters | ((state: IndexUiState) => IndexUiState)) => string;
-    addWidgets: (widgets: Array<Widget | IndexWidget>) => IndexWidget;
-    removeWidgets: (widgets: Array<Widget | IndexWidget>) => IndexWidget;
+    addWidgets: (widgets: Array<Widget | IndexWidget | Widget[]>) => IndexWidget;
+    removeWidgets: (widgets: Array<Widget | IndexWidget | Widget[]>) => IndexWidget;
     init: (options: IndexInitOptions) => void;
     render: (options: IndexRenderOptions) => void;
     dispose: () => void;
@@ -4782,6 +4782,12 @@ declare type IndexWidget<TUiState extends UiState = UiState> = Omit<Widget<Index
      * Can only be called after `init`.
      */
     setIndexUiState: (indexUiState: TUiState[string] | ((previousIndexUiState: TUiState[string]) => TUiState[string])) => void;
+    /**
+     * This index is isolated, meaning it will not be merged with the main
+     * helper's state.
+     * @private
+     */
+    _isolated: boolean;
 };
 
 declare type IndexWidgetDescription = {
@@ -4790,7 +4796,45 @@ declare type IndexWidgetDescription = {
 };
 
 declare type IndexWidgetParams = {
+    /**
+     * The index or composition id to target.
+     */
     indexName: string;
+    /**
+     * Id to use for the index if there are multiple indices with the same name.
+     * This will be used to create the URL and the render state.
+     */
+    indexId?: string;
+    /**
+     * If `true`, the index will not be merged with the main helper's state.
+     * This means that the index will not be part of the main search request.
+     *
+     * @default false
+     */
+    EXPERIMENTAL_isolated?: false;
+} | {
+    /**
+     * If `true`, the index will not be merged with the main helper's state.
+     * This means that the index will not be part of the main search request.
+     *
+     * This option is EXPERIMENTAL, and implementation details may change in the future.
+     * Things that could change are:
+     * - which widgets get rendered when a change happens
+     * - whether the index searches automatically
+     * - whether the index is included in the URL / UiState
+     * - whether the index is included in server-side rendering
+     *
+     * @default false
+     */
+    EXPERIMENTAL_isolated: true;
+    /**
+     * The index or composition id to target.
+     */
+    indexName?: string;
+    /**
+     * Id to use for the index if there are multiple indices with the same name.
+     * This will be used to create the URL and the render state.
+     */
     indexId?: string;
 };
 
@@ -5125,7 +5169,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
      * Widgets can be added either before or after InstantSearch has started.
      * @param widgets The array of widgets to add to InstantSearch.
      */
-    addWidgets(widgets: Array<Widget | IndexWidget>): this;
+    addWidgets(widgets: Array<Widget | IndexWidget | Widget[]>): this;
     /**
      * Removes a widget from the search instance.
      * @deprecated This method will still be supported in 4.x releases, but not further. It is replaced by `removeWidgets([widget])`
@@ -5140,7 +5184,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
      *
      * The widgets must implement a `dispose()` method to clear their states.
      */
-    removeWidgets(widgets: Array<Widget | IndexWidget>): this;
+    removeWidgets(widgets: Array<Widget | IndexWidget | Widget[]>): this;
     /**
      * Ends the initialization of InstantSearch.js and triggers the
      * first search.

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

@@ -4758,8 +4758,8 @@ declare type IndexWidget<TUiState extends UiState = UiState> = Omit<Widget<Index
     getParent: () => IndexWidget | null;
     getWidgets: () => Array<Widget | IndexWidget>;
     createURL: (nextState: SearchParameters | ((state: IndexUiState) => IndexUiState)) => string;
-    addWidgets: (widgets: Array<Widget | IndexWidget>) => IndexWidget;
-    removeWidgets: (widgets: Array<Widget | IndexWidget>) => IndexWidget;
+    addWidgets: (widgets: Array<Widget | IndexWidget | Widget[]>) => IndexWidget;
+    removeWidgets: (widgets: Array<Widget | IndexWidget | Widget[]>) => IndexWidget;
     init: (options: IndexInitOptions) => void;
     render: (options: IndexRenderOptions) => void;
     dispose: () => void;
@@ -4782,6 +4782,12 @@ declare type IndexWidget<TUiState extends UiState = UiState> = Omit<Widget<Index
      * Can only be called after `init`.
      */
     setIndexUiState: (indexUiState: TUiState[string] | ((previousIndexUiState: TUiState[string]) => TUiState[string])) => void;
+    /**
+     * This index is isolated, meaning it will not be merged with the main
+     * helper's state.
+     * @private
+     */
+    _isolated: boolean;
 };
 
 declare type IndexWidgetDescription = {
@@ -4790,7 +4796,45 @@ declare type IndexWidgetDescription = {
 };
 
 declare type IndexWidgetParams = {
+    /**
+     * The index or composition id to target.
+     */
     indexName: string;
+    /**
+     * Id to use for the index if there are multiple indices with the same name.
+     * This will be used to create the URL and the render state.
+     */
+    indexId?: string;
+    /**
+     * If `true`, the index will not be merged with the main helper's state.
+     * This means that the index will not be part of the main search request.
+     *
+     * @default false
+     */
+    EXPERIMENTAL_isolated?: false;
+} | {
+    /**
+     * If `true`, the index will not be merged with the main helper's state.
+     * This means that the index will not be part of the main search request.
+     *
+     * This option is EXPERIMENTAL, and implementation details may change in the future.
+     * Things that could change are:
+     * - which widgets get rendered when a change happens
+     * - whether the index searches automatically
+     * - whether the index is included in the URL / UiState
+     * - whether the index is included in server-side rendering
+     *
+     * @default false
+     */
+    EXPERIMENTAL_isolated: true;
+    /**
+     * The index or composition id to target.
+     */
+    indexName?: string;
+    /**
+     * Id to use for the index if there are multiple indices with the same name.
+     * This will be used to create the URL and the render state.
+     */
     indexId?: string;
 };
 
@@ -5125,7 +5169,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
      * Widgets can be added either before or after InstantSearch has started.
      * @param widgets The array of widgets to add to InstantSearch.
      */
-    addWidgets(widgets: Array<Widget | IndexWidget>): this;
+    addWidgets(widgets: Array<Widget | IndexWidget | Widget[]>): this;
     /**
      * Removes a widget from the search instance.
      * @deprecated This method will still be supported in 4.x releases, but not further. It is replaced by `removeWidgets([widget])`
@@ -5140,7 +5184,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
      *
      * The widgets must implement a `dispose()` method to clear their states.
      */
-    removeWidgets(widgets: Array<Widget | IndexWidget>): this;
+    removeWidgets(widgets: Array<Widget | IndexWidget | Widget[]>): this;
     /**
      * Ends the initialization of InstantSearch.js and triggers the
      * first search.