useRoute: type-safe data access for other routes on the page

Author: pcattori

packages/react-router/index.ts

@@ -144,6 +144,7 @@ export {
   useRouteError,
   useRouteLoaderData,
   useRoutes,
+  useRoute,
 } from "./lib/hooks";
 
 // Expose old RR DOM API

packages/react-router/lib/hooks.tsx

@@ -50,8 +50,13 @@ import {
   resolveTo,
   stripBasename,
 } from "./router/utils";
-import type { SerializeFrom } from "./types/route-data";
+import type {
+  GetActionData,
+  GetLoaderData,
+  SerializeFrom,
+} from "./types/route-data";
 import type { unstable_ClientOnErrorFunction } from "./components";
+import type { RouteModules } from "./types/register";
 
 /**
  * Resolves a URL against the current {@link Location}.
@@ -1838,3 +1843,19 @@ function warningOnce(key: string, cond: boolean, message: string) {
     warning(false, message);
   }
 }
+
+type UseRoute<T extends keyof RouteModules> = {
+  loaderData: GetLoaderData<RouteModules[T]>;
+  actionData: GetActionData<RouteModules[T]>;
+};
+export function useRoute<T extends keyof RouteModules>(
+  routeId: T,
+): UseRoute<T> | undefined {
+  const state = useDataRouterState(DataRouterStateHook.UseRouteLoaderData);
+  const route = state.matches.find(({ route }) => route.id === routeId);
+  if (route === undefined) return undefined;
+  return {
+    loaderData: state.loaderData[routeId],
+    actionData: state.actionData?.[routeId],
+  };
+}

packages/react-router/lib/types/register.ts

@@ -1,3 +1,5 @@
+import type { RouteModule } from "./route-module";
+
 /**
  * Apps can use this interface to "register" app-wide types for React Router via interface declaration merging and module augmentation.
  * React Router should handle this for you via type generation.
@@ -7,6 +9,7 @@
 export interface Register {
   // pages
   // routeFiles
+  // routeModules
 }
 
 // pages
@@ -25,3 +28,10 @@ export type RouteFiles = Register extends {
 }
   ? Registered
   : AnyRouteFiles;
+
+type AnyRouteModules = Record<string, RouteModule>;
+export type RouteModules = Register extends {
+  routeModules: infer Registered extends AnyRouteModules;
+}
+  ? Registered
+  : AnyRouteModules;