feat: add option to disable favorite iModels fetching

common/changes/@itwin/imodel-browser-react/leobelanger-disable-favorites_2025-11-18-21-33.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/imodel-browser-react",
+      "comment": "added option to disable fetching favorite iModels",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@itwin/imodel-browser-react"
+}

packages/modules/imodel-browser/src/containers/iModelGrid/IModelGrid.tsx

@@ -42,6 +42,8 @@ export interface IModelGridProps {
   onThumbnailClick?(iModel: IModelFull): void;
   /** When true, prevents automatically adding iModels to recents when thumbnail is clicked. Default is false. */
   disableAddToRecents?: boolean;
+  /** When true, prevents automatically fetching favorite iModels when the component is mounted. Default is false. */
+  disableFavorites?: boolean;
   /** Configure IModel sorting behavior. */
   sortOptions?: IModelSortOptions;
   /** List of actions to build for each imodel context menu. */
@@ -119,6 +121,7 @@ export const IModelGrid = (props: IModelGridProps) => {
       iTwinId={props.iTwinId}
       accessToken={props.accessToken}
       serverEnvironmentPrefix={props.apiOverrides?.serverEnvironmentPrefix}
+      disabled={props.disableFavorites}
     >
       <ITwinGridInternal {...props} />
     </IModelFavoritesProvider>

packages/modules/imodel-browser/src/containers/iModelGrid/useIModelFavorites.ts

@@ -13,6 +13,7 @@ import * as iModelApi from "../../utils/iModelApi";
  * @param iTwinId - The ID of the iTwin for which to fetch favorites.
  * @param accessToken - Access token that requires the `itwin-platform` scope. Provide a function that returns the token to prevent the token from expiring.
  * @param serverEnvironmentPrefix - Optional server environment prefix.
+ * @param disabled - Optional flag to disable fetching of the favorites in the hook.
  * @returns An object containing:
  * - {Set<string>} iModelFavorites - A set of iModel IDs that are marked as favorites.
  * - {function} addIModelToFavorites - A function to add an iModel to favorites.
@@ -21,7 +22,8 @@ import * as iModelApi from "../../utils/iModelApi";
 export const useIModelFavorites = (
   iTwinId: string | undefined,
   accessToken: AccessTokenProvider | undefined,
-  serverEnvironmentPrefix?: "dev" | "qa" | ""
+  serverEnvironmentPrefix?: "dev" | "qa" | "",
+  disabled?: boolean
 ): {
   iModelFavorites: Set<string>;
   addIModelToFavorites: (iModelId: string) => Promise<void>;
@@ -91,7 +93,7 @@ export const useIModelFavorites = (
      */
     const fetchIModelFavorites = async (abortSignal?: AbortSignal) => {
       try {
-        if (!iTwinId || !accessToken) {
+        if (disabled || !iTwinId || !accessToken) {
           setIModelFavorites(new Set());
           return;
         }
@@ -115,7 +117,7 @@ export const useIModelFavorites = (
     return () => {
       controller.abort();
     };
-  }, [iTwinId, accessToken, serverEnvironmentPrefix]);
+  }, [disabled, iTwinId, accessToken, serverEnvironmentPrefix]);
 
   return {
     iModelFavorites,

packages/modules/imodel-browser/src/contexts/IModelFavoritesContext.tsx

@@ -22,21 +22,24 @@ export interface IModelFavoritesProviderProps {
   accessToken?: AccessTokenProvider;
   serverEnvironmentPrefix?: string;
   children: React.ReactNode;
+  disabled?: boolean;
 }
 
 export const IModelFavoritesProvider = ({
   iTwinId,
   accessToken,
   serverEnvironmentPrefix,
   children,
+  disabled,
 }: IModelFavoritesProviderProps) => {
   const { iModelFavorites, addIModelToFavorites, removeIModelFromFavorites } =
     useIModelFavorites(
       iTwinId,
       accessToken,
       serverEnvironmentPrefix === "dev" || serverEnvironmentPrefix === "qa"
         ? serverEnvironmentPrefix
-        : undefined
+        : undefined,
+      disabled
     );
 
   const value = React.useMemo<IModelFavoritesContextValue>(