@tanstack/react-router 1.31.29 → 1.32.0

package/dist/cjs/index.cjs

@@ -26,6 +26,7 @@ const routerContext = require("./routerContext.cjs");
 const useRouteContext = require("./useRouteContext.cjs");
 const useRouter = require("./useRouter.cjs");
 const useRouterState = require("./useRouterState.cjs");
+const useLocation = require("./useLocation.cjs");
 const utils = require("./utils.cjs");
 const notFound = require("./not-found.cjs");
 Object.defineProperty(exports, "createBrowserHistory", {
@@ -130,6 +131,7 @@ exports.getRouterContext = routerContext.getRouterContext;
 exports.useRouteContext = useRouteContext.useRouteContext;
 exports.useRouter = useRouter.useRouter;
 exports.useRouterState = useRouterState.useRouterState;
+exports.useLocation = useLocation.useLocation;
 exports.deepEqual = utils.deepEqual;
 exports.escapeJSON = utils.escapeJSON;
 exports.functionalUpdate = utils.functionalUpdate;

package/dist/cjs/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/cjs/index.d.cts

@@ -27,6 +27,7 @@ export { getRouterContext, } from './routerContext.cjs';
 export { useRouteContext } from './useRouteContext.cjs';
 export { useRouter } from './useRouter.cjs';
 export { useRouterState } from './useRouterState.cjs';
+export { useLocation } from './useLocation.cjs';
 export { escapeJSON, // SSR
 useLayoutEffect, // SSR
 pick, functionalUpdate, replaceEqualDeep, isPlainObject, isPlainArray, deepEqual, useStableCallback, shallow, } from './utils';

package/dist/cjs/useLocation.cjs

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const useRouterState = require("./useRouterState.cjs");
+function useLocation(opts) {
+  return useRouterState.useRouterState({
+    select: (state) => (opts == null ? void 0 : opts.select) ? opts.select(state.location) : state.location
+  });
+}
+exports.useLocation = useLocation;
+//# sourceMappingURL=useLocation.cjs.map

package/dist/cjs/useLocation.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLocation.cjs","sources":["../../src/useLocation.tsx"],"sourcesContent":["import { useRouterState } from './useRouterState'\nimport type { AnyRouter, RegisteredRouter, RouterState } from './router'\n\nexport function useLocation<\n  TRouter extends AnyRouter = RegisteredRouter,\n  TLocationState = RouterState<TRouter['routeTree']>['location'],\n  TSelected = TLocationState,\n>(opts?: { select?: (state: TLocationState) => TSelected }): TSelected {\n  return useRouterState({\n    select: (state) =>\n      opts?.select\n        ? opts.select(state.location as TLocationState)\n        : (state.location as TSelected),\n  })\n}\n"],"names":["useRouterState"],"mappings":";;;AAGO,SAAS,YAId,MAAqE;AACrE,SAAOA,8BAAe;AAAA,IACpB,QAAQ,CAAC,WACP,6BAAM,UACF,KAAK,OAAO,MAAM,QAA0B,IAC3C,MAAM;AAAA,EAAA,CACd;AACH;;"}

package/dist/cjs/useLocation.d.cts

@@ -0,0 +1,4 @@
+import type { AnyRouter, RegisteredRouter, RouterState } from './router.cjs';
+export declare function useLocation<TRouter extends AnyRouter = RegisteredRouter, TLocationState = RouterState<TRouter['routeTree']>['location'], TSelected = TLocationState>(opts?: {
+    select?: (state: TLocationState) => TSelected;
+}): TSelected;

package/dist/esm/index.d.ts

@@ -27,6 +27,7 @@ export { getRouterContext, } from './routerContext.js';
 export { useRouteContext } from './useRouteContext.js';
 export { useRouter } from './useRouter.js';
 export { useRouterState } from './useRouterState.js';
+export { useLocation } from './useLocation.js';
 export { escapeJSON, // SSR
 useLayoutEffect, // SSR
 pick, functionalUpdate, replaceEqualDeep, isPlainObject, isPlainArray, deepEqual, useStableCallback, shallow, } from './utils';

package/dist/esm/index.js

@@ -24,6 +24,7 @@ import { getRouterContext } from "./routerContext.js";
 import { useRouteContext } from "./useRouteContext.js";
 import { useRouter } from "./useRouter.js";
 import { useRouterState } from "./useRouterState.js";
+import { useLocation } from "./useLocation.js";
 import { deepEqual, escapeJSON, functionalUpdate, isPlainArray, isPlainObject, pick, replaceEqualDeep, shallow, useLayoutEffect, useStableCallback } from "./utils.js";
 import { CatchNotFound, DefaultGlobalNotFound, isNotFound, notFound } from "./not-found.js";
 export {
@@ -118,6 +119,7 @@ export {
   useLinkProps,
   useLoaderData,
   useLoaderDeps,
+  useLocation,
   useMatch,
   useMatchRoute,
   useMatches,

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/esm/useLocation.d.ts

@@ -0,0 +1,4 @@
+import type { AnyRouter, RegisteredRouter, RouterState } from './router.js';
+export declare function useLocation<TRouter extends AnyRouter = RegisteredRouter, TLocationState = RouterState<TRouter['routeTree']>['location'], TSelected = TLocationState>(opts?: {
+    select?: (state: TLocationState) => TSelected;
+}): TSelected;

package/dist/esm/useLocation.js

@@ -0,0 +1,10 @@
+import { useRouterState } from "./useRouterState.js";
+function useLocation(opts) {
+  return useRouterState({
+    select: (state) => (opts == null ? void 0 : opts.select) ? opts.select(state.location) : state.location
+  });
+}
+export {
+  useLocation
+};
+//# sourceMappingURL=useLocation.js.map

package/dist/esm/useLocation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLocation.js","sources":["../../src/useLocation.tsx"],"sourcesContent":["import { useRouterState } from './useRouterState'\nimport type { AnyRouter, RegisteredRouter, RouterState } from './router'\n\nexport function useLocation<\n  TRouter extends AnyRouter = RegisteredRouter,\n  TLocationState = RouterState<TRouter['routeTree']>['location'],\n  TSelected = TLocationState,\n>(opts?: { select?: (state: TLocationState) => TSelected }): TSelected {\n  return useRouterState({\n    select: (state) =>\n      opts?.select\n        ? opts.select(state.location as TLocationState)\n        : (state.location as TSelected),\n  })\n}\n"],"names":[],"mappings":";AAGO,SAAS,YAId,MAAqE;AACrE,SAAO,eAAe;AAAA,IACpB,QAAQ,CAAC,WACP,6BAAM,UACF,KAAK,OAAO,MAAM,QAA0B,IAC3C,MAAM;AAAA,EAAA,CACd;AACH;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/react-router",
-  "version": "1.31.29",
+  "version": "1.32.0",
   "description": "",
   "author": "Tanner Linsley",
   "license": "MIT",

package/src/index.tsx

@@ -258,6 +258,7 @@ export {
 export { useRouteContext } from './useRouteContext'
 export { useRouter } from './useRouter'
 export { useRouterState } from './useRouterState'
+export { useLocation } from './useLocation'
 export {
   escapeJSON, // SSR
   useLayoutEffect, // SSR

package/src/useLocation.tsx

@@ -0,0 +1,15 @@
+import { useRouterState } from './useRouterState'
+import type { AnyRouter, RegisteredRouter, RouterState } from './router'
+
+export function useLocation<
+  TRouter extends AnyRouter = RegisteredRouter,
+  TLocationState = RouterState<TRouter['routeTree']>['location'],
+  TSelected = TLocationState,
+>(opts?: { select?: (state: TLocationState) => TSelected }): TSelected {
+  return useRouterState({
+    select: (state) =>
+      opts?.select
+        ? opts.select(state.location as TLocationState)
+        : (state.location as TSelected),
+  })
+}