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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/react-router",
   "author": "Tanner Linsley",
-  "version": "0.0.1-beta.215",
+  "version": "0.0.1-beta.216",
   "license": "MIT",
   "repository": "tanstack/router",
   "homepage": "https://tanstack.com/router",
@@ -42,7 +42,7 @@
     "@babel/runtime": "^7.16.7",
     "tiny-invariant": "^1.3.1",
     "tiny-warning": "^1.0.3",
-    "@tanstack/history": "0.0.1-beta.215"
+    "@tanstack/history": "0.0.1-beta.216"
   },
   "scripts": {
     "build": "rollup --config rollup.config.js"

package/src/RouterProvider.tsx

@@ -27,7 +27,13 @@ import {
   trimPathRight,
 } from './path'
 import { isRedirect } from './redirects'
-import { AnyPathParams, AnyRoute, AnySearchSchema, Route } from './route'
+import {
+  AnyPathParams,
+  AnyRoute,
+  AnySearchSchema,
+  LoaderFnContext,
+  Route,
+} from './route'
 import {
   FullSearchSchema,
   ParseRoute,
@@ -960,22 +966,11 @@ export function RouterProvider<
             if (match.isFetching) {
               loadPromise = getRouteMatch(state, match.id)?.loadPromise
             } else {
-              matches[index] = match = {
-                ...match,
-                isFetching: true,
-              }
+              const cause = state.matches.find((d) => d.id === match.id)
+                ? 'stay'
+                : 'enter'
 
-              const componentsPromise = Promise.all(
-                componentTypes.map(async (type) => {
-                  const component = route.options[type]
-
-                  if ((component as any)?.preload) {
-                    await (component as any).preload()
-                  }
-                }),
-              )
-
-              const loaderPromise = route.options.loader?.({
+              const loaderContext: LoaderFnContext = {
                 params: match.params,
                 search: match.search,
                 preload: !!preload,
@@ -985,12 +980,42 @@ export function RouterProvider<
                 location: state.location,
                 navigate: (opts) =>
                   navigate({ ...opts, from: match.pathname } as any),
-              })
+                cause,
+              }
+
+              // Default to reloading the route all the time
+              const shouldReload =
+                route.options.shouldReload?.(loaderContext) ?? true
 
-              loadPromise = Promise.all([
-                componentsPromise,
-                loaderPromise,
-              ]).then((d) => d[1])
+              // 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 as any)?.preload) {
+                      await (component as any).preload()
+                    }
+                  }),
+                )
+
+                const loaderPromise = route.options.loader?.(loaderContext)
+
+                loadPromise = Promise.all([
+                  componentsPromise,
+                  loaderPromise,
+                ]).then((d) => d[1])
+              }
             }
 
             matches[index] = match = {

package/src/route.ts

@@ -108,6 +108,14 @@ export type BaseRouteOptions<
 > = RoutePathOptions<TCustomId, TPath> & {
   getParentRoute: () => TParentRoute
   validateSearch?: SearchSchemaValidator<TSearchSchema>
+  shouldReload?: (
+    match: LoaderFnContext<
+      TAllParams,
+      TFullSearchSchema,
+      TAllContext,
+      TRouteContext
+    >,
+  ) => any
 } & (keyof PickRequired<RouteContext> extends never
     ? // This async function is called before a route is loaded.
       // If an error is thrown here, the route's loader will not be called.
@@ -268,9 +276,7 @@ export type RouteLoadFn<
     TFullSearchSchema,
     TAllContext,
     TRouteContext
-  > & {
-    parentMatchPromise?: Promise<void>
-  },
+  >,
 ) => Promise<TLoaderData> | TLoaderData
 
 export interface LoaderFnContext<
@@ -286,6 +292,8 @@ export interface LoaderFnContext<
   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