@tanstack/react-router 0.0.1-beta.215 → 0.0.1-beta.216

package/build/types/route.d.ts

@@ -34,6 +34,7 @@ export type ParamsFallback<TPath extends string, TParams> = unknown extends TPar
 export type BaseRouteOptions<TParentRoute extends AnyRoute = AnyRoute, TCustomId extends string = string, TPath extends string = string, TSearchSchema extends Record<string, any> = {}, TFullSearchSchema extends Record<string, any> = TSearchSchema, TParams extends AnyPathParams = {}, TAllParams = ParamsFallback<TPath, TParams>, TRouteContext extends RouteContext = RouteContext, TAllContext extends Record<string, any> = AnyContext, TLoaderData extends any = unknown> = RoutePathOptions<TCustomId, TPath> & {
     getParentRoute: () => TParentRoute;
     validateSearch?: SearchSchemaValidator<TSearchSchema>;
+    shouldReload?: (match: LoaderFnContext<TAllParams, TFullSearchSchema, TAllContext, TRouteContext>) => any;
 } & (keyof PickRequired<RouteContext> extends never ? {
     beforeLoad?: BeforeLoadFn<TFullSearchSchema, TParentRoute, TAllParams, TRouteContext>;
 } : {
@@ -85,9 +86,7 @@ export type DefinedPathParamWarning = 'Path params cannot be redefined by child
 export type ParentParams<TParentParams> = AnyPathParams extends TParentParams ? {} : {
     [Key in keyof TParentParams]?: DefinedPathParamWarning;
 };
-export type RouteLoadFn<TAllParams = {}, TFullSearchSchema extends Record<string, any> = {}, TAllContext extends Record<string, any> = AnyContext, TRouteContext extends Record<string, any> = AnyContext, TLoaderData extends any = unknown> = (match: LoaderFnContext<TAllParams, TFullSearchSchema, TAllContext, TRouteContext> & {
-    parentMatchPromise?: Promise<void>;
-}) => Promise<TLoaderData> | TLoaderData;
+export type RouteLoadFn<TAllParams = {}, TFullSearchSchema extends Record<string, any> = {}, TAllContext extends Record<string, any> = AnyContext, TRouteContext extends Record<string, any> = AnyContext, TLoaderData extends any = unknown> = (match: LoaderFnContext<TAllParams, TFullSearchSchema, TAllContext, TRouteContext>) => Promise<TLoaderData> | TLoaderData;
 export interface LoaderFnContext<TAllParams = {}, TFullSearchSchema extends Record<string, any> = {}, TAllContext extends Record<string, any> = AnyContext, TRouteContext extends Record<string, any> = AnyContext> {
     abortController: AbortController;
     preload: boolean;
@@ -96,6 +95,8 @@ export interface LoaderFnContext<TAllParams = {}, TFullSearchSchema extends Reco
     context: Expand<Assign<TAllContext, TRouteContext>>;
     location: ParsedLocation<TFullSearchSchema>;
     navigate: (opts: NavigateOptions<AnyRoute>) => Promise<void>;
+    parentMatchPromise?: Promise<void>;
+    cause: 'enter' | 'stay';
 }
 export type SearchFilter<T, U = T> = (prev: T) => U;
 export type ResolveId<TParentRoute, TCustomId extends string, TPath extends string> = TParentRoute extends {

package/build/umd/index.development.js

@@ -1687,17 +1687,8 @@
           if (match.isFetching) {
             loadPromise = getRouteMatch(state, match.id)?.loadPromise;
           } else {
-            matches[index] = match = {
-              ...match,
-              isFetching: true
-            };
-            const componentsPromise = Promise.all(componentTypes.map(async type => {
-              const component = route.options[type];
-              if (component?.preload) {
-                await component.preload();
-              }
-            }));
-            const loaderPromise = route.options.loader?.({
+            const cause = state.matches.find(d => d.id === match.id) ? 'stay' : 'enter';
+            const loaderContext = {
               params: match.params,
               search: match.search,
               preload: !!preload,
@@ -1708,9 +1699,33 @@
               navigate: opts => navigate({
                 ...opts,
                 from: match.pathname
-              })
-            });
-            loadPromise = Promise.all([componentsPromise, loaderPromise]).then(d => d[1]);
+              }),
+              cause
+            };
+
+            // Default to reloading the route all the time
+            const shouldReload = route.options.shouldReload?.(loaderContext) ?? true;
+
+            // If the user doesn't want the route to reload, just
+            // resolve with the existing loader data
+
+            if (!shouldReload) {
+              loadPromise = Promise.resolve(match.loaderData);
+            } else {
+              // Otherwise, load the route
+              matches[index] = match = {
+                ...match,
+                isFetching: true
+              };
+              const componentsPromise = Promise.all(componentTypes.map(async type => {
+                const component = route.options[type];
+                if (component?.preload) {
+                  await component.preload();
+                }
+              }));
+              const loaderPromise = route.options.loader?.(loaderContext);
+              loadPromise = Promise.all([componentsPromise, loaderPromise]).then(d => d[1]);
+            }
           }
           matches[index] = match = {
             ...match,