@tanstack/router-core 1.171.3 → 1.171.5

package/dist/esm/scroll-restoration-inline.d.ts

@@ -1,6 +1 @@
-export default function (options: {
-    storageKey: string;
-    key?: string;
-    behavior?: ScrollToOptions['behavior'];
-    shouldScrollRestoration?: boolean;
-}): void;
+export default function (storageKey: string, key?: string): void;

package/dist/esm/scroll-restoration-inline.js

@@ -1,5 +1,5 @@
 //#region src/scroll-restoration-inline.ts?script-string
-var scroll_restoration_inline_default = "function(t){let s;try{s=JSON.parse(sessionStorage.getItem(t.storageKey)||\"{}\")}catch(e){console.error(e);return}const c=t.key||window.history.state?.__TSR_key,r=c?s[c]:void 0;if(t.shouldScrollRestoration&&r&&typeof r==\"object\"&&Object.keys(r).length>0){for(const e in r){const o=r[e];if(!o||typeof o!=\"object\")continue;const l=o.scrollX,i=o.scrollY;if(!(!Number.isFinite(l)||!Number.isFinite(i))){if(e===\"window\")window.scrollTo({top:i,left:l,behavior:t.behavior});else if(e){let n;try{n=document.querySelector(e)}catch{continue}n&&(n.scrollLeft=l,n.scrollTop=i)}}}return}const a=window.location.hash.split(\"#\",2)[1];if(a){const e=window.history.state?.__hashScrollIntoViewOptions??!0;if(e){const o=document.getElementById(a);o&&o.scrollIntoView(e)}return}window.scrollTo({top:0,left:0,behavior:t.behavior})}";
+var scroll_restoration_inline_default = "function(a,f){let l;try{l=JSON.parse(sessionStorage.getItem(a)||\"{}\")}catch{return}const n=l?.[f||history.state?.__TSR_key];let c=!1;for(const t in n){const e=n[t],o=e?.scrollX,s=e?.scrollY;if(Number.isFinite(o)&&Number.isFinite(s)){if(t===\"window\")scrollTo(o,s),c=!0;else if(t)try{const r=document.querySelector(t);r&&(r.scrollLeft=o,r.scrollTop=s)}catch{}}}if(c)return;const i=location.hash.slice(1);if(i){const t=history.state?.__hashScrollIntoViewOptions??!0;if(t){const e=document.getElementById(i);e&&e.scrollIntoView(t)}return}scrollTo(0,0)}";
 //#endregion
 export { scroll_restoration_inline_default as default };
 

package/dist/esm/scroll-restoration-inline.js.map

@@ -1 +1 @@
-{"version":3,"file":"scroll-restoration-inline.js","names":[],"sources":["../../src/scroll-restoration-inline.ts?script-string"],"sourcesContent":["export default function (options: {\n  storageKey: string\n  key?: string\n  behavior?: ScrollToOptions['behavior']\n  shouldScrollRestoration?: boolean\n}) {\n  let byKey\n\n  try {\n    byKey = JSON.parse(sessionStorage.getItem(options.storageKey) || '{}')\n  } catch (error) {\n    console.error(error)\n    return\n  }\n\n  const resolvedKey = options.key || window.history.state?.__TSR_key\n  const elementEntries = resolvedKey ? byKey[resolvedKey] : undefined\n\n  if (\n    options.shouldScrollRestoration &&\n    elementEntries &&\n    typeof elementEntries === 'object' &&\n    Object.keys(elementEntries).length > 0\n  ) {\n    for (const elementSelector in elementEntries) {\n      const entry = elementEntries[elementSelector]\n\n      if (!entry || typeof entry !== 'object') {\n        continue\n      }\n\n      const scrollX = entry.scrollX\n      const scrollY = entry.scrollY\n\n      if (!Number.isFinite(scrollX) || !Number.isFinite(scrollY)) {\n        continue\n      }\n\n      if (elementSelector === 'window') {\n        window.scrollTo({\n          top: scrollY,\n          left: scrollX,\n          behavior: options.behavior,\n        })\n      } else if (elementSelector) {\n        let element\n\n        try {\n          element = document.querySelector(elementSelector)\n        } catch {\n          continue\n        }\n\n        if (element) {\n          element.scrollLeft = scrollX\n          element.scrollTop = scrollY\n        }\n      }\n    }\n\n    return\n  }\n\n  const hash = window.location.hash.split('#', 2)[1]\n\n  if (hash) {\n    const hashScrollIntoViewOptions =\n      window.history.state?.__hashScrollIntoViewOptions ?? true\n\n    if (hashScrollIntoViewOptions) {\n      const el = document.getElementById(hash)\n      if (el) {\n        el.scrollIntoView(hashScrollIntoViewOptions)\n      }\n    }\n\n    return\n  }\n\n  window.scrollTo({ top: 0, left: 0, behavior: options.behavior })\n}\n"],"mappings":";AAAA,IAAA,oCAAe"}
+{"version":3,"file":"scroll-restoration-inline.js","names":[],"sources":["../../src/scroll-restoration-inline.ts?script-string"],"sourcesContent":["export default function (storageKey: string, key?: string) {\n  let byKey\n\n  try {\n    byKey = JSON.parse(sessionStorage.getItem(storageKey) || '{}')\n  } catch {\n    return\n  }\n\n  const elementEntries = byKey?.[key || history.state?.__TSR_key]\n  let windowRestored = false\n\n  for (const elementSelector in elementEntries) {\n    const entry = elementEntries[elementSelector]\n    const scrollX = entry?.scrollX\n    const scrollY = entry?.scrollY\n\n    if (Number.isFinite(scrollX) && Number.isFinite(scrollY)) {\n      if (elementSelector === 'window') {\n        scrollTo(scrollX, scrollY)\n        windowRestored = true\n      } else if (elementSelector) {\n        try {\n          const element = document.querySelector(elementSelector)\n          if (element) {\n            element.scrollLeft = scrollX\n            element.scrollTop = scrollY\n          }\n        } catch {}\n      }\n    }\n  }\n\n  if (windowRestored) return\n\n  const hash = location.hash.slice(1)\n\n  if (hash) {\n    const hashScrollIntoViewOptions =\n      history.state?.__hashScrollIntoViewOptions ?? true\n\n    if (hashScrollIntoViewOptions) {\n      const el = document.getElementById(hash)\n      if (el) {\n        el.scrollIntoView(hashScrollIntoViewOptions)\n      }\n    }\n\n    return\n  }\n\n  scrollTo(0, 0)\n}\n"],"mappings":";AAAA,IAAA,oCAAe"}

package/dist/esm/scroll-restoration-script/server.js

@@ -2,13 +2,10 @@ import { escapeHtml } from "../utils.js";
 import { defaultGetScrollRestorationKey, storageKey } from "../scroll-restoration.js";
 import scroll_restoration_inline_default from "../scroll-restoration-inline.js";
 //#region src/scroll-restoration-script/server.ts
-const defaultInlineScrollRestorationScript = `(${scroll_restoration_inline_default})(${escapeHtml(JSON.stringify({
-	storageKey,
-	shouldScrollRestoration: true
-}))})`;
-function getScrollRestorationScript(options) {
-	if (options.storageKey === "tsr-scroll-restoration-v1_3" && options.shouldScrollRestoration === true && options.key === void 0 && options.behavior === void 0) return defaultInlineScrollRestorationScript;
-	return `(${scroll_restoration_inline_default})(${escapeHtml(JSON.stringify(options))})`;
+const defaultInlineScrollRestorationScript = `(${scroll_restoration_inline_default})(${escapeHtml(JSON.stringify(storageKey))})`;
+function getScrollRestorationScript(key) {
+	if (key === void 0) return defaultInlineScrollRestorationScript;
+	return `(${scroll_restoration_inline_default})(${escapeHtml(JSON.stringify(storageKey))},${escapeHtml(JSON.stringify(key))})`;
 }
 function getScrollRestorationScriptForRouter(router) {
 	if (typeof router.options.scrollRestoration === "function" && !router.options.scrollRestoration({ location: router.latestLocation })) return null;
@@ -17,11 +14,7 @@ function getScrollRestorationScriptForRouter(router) {
 	const location = router.latestLocation;
 	const userKey = getKey(location);
 	if (userKey === defaultGetScrollRestorationKey(location)) return defaultInlineScrollRestorationScript;
-	return getScrollRestorationScript({
-		storageKey,
-		shouldScrollRestoration: true,
-		key: userKey
-	});
+	return getScrollRestorationScript(userKey);
 }
 //#endregion
 export { getScrollRestorationScriptForRouter };

package/dist/esm/scroll-restoration-script/server.js.map

@@ -1 +1 @@
-{"version":3,"file":"server.js","names":[],"sources":["../../../src/scroll-restoration-script/server.ts"],"sourcesContent":["import minifiedScrollRestorationScript from '../scroll-restoration-inline?script-string'\nimport {\n  defaultGetScrollRestorationKey,\n  storageKey,\n} from '../scroll-restoration'\nimport { escapeHtml } from '../utils'\nimport type { AnyRouter } from '../router'\n\ntype InlineScrollRestorationScriptOptions = {\n  storageKey: string\n  key?: string\n  behavior?: ScrollToOptions['behavior']\n  shouldScrollRestoration?: boolean\n}\n\nconst defaultInlineScrollRestorationScript = `(${minifiedScrollRestorationScript})(${escapeHtml(\n  JSON.stringify({\n    storageKey,\n    shouldScrollRestoration: true,\n  } satisfies InlineScrollRestorationScriptOptions),\n)})`\n\nfunction getScrollRestorationScript(\n  options: InlineScrollRestorationScriptOptions,\n) {\n  if (\n    options.storageKey === storageKey &&\n    options.shouldScrollRestoration === true &&\n    options.key === undefined &&\n    options.behavior === undefined\n  ) {\n    return defaultInlineScrollRestorationScript\n  }\n\n  return `(${minifiedScrollRestorationScript})(${escapeHtml(JSON.stringify(options))})`\n}\n\nexport function getScrollRestorationScriptForRouter(router: AnyRouter) {\n  if (\n    typeof router.options.scrollRestoration === 'function' &&\n    !router.options.scrollRestoration({ location: router.latestLocation })\n  ) {\n    return null\n  }\n\n  const getKey = router.options.getScrollRestorationKey\n  if (!getKey) {\n    return defaultInlineScrollRestorationScript\n  }\n\n  const location = router.latestLocation\n  const userKey = getKey(location)\n  const defaultKey = defaultGetScrollRestorationKey(location)\n\n  if (userKey === defaultKey) {\n    return defaultInlineScrollRestorationScript\n  }\n\n  return getScrollRestorationScript({\n    storageKey,\n    shouldScrollRestoration: true,\n    key: userKey,\n  })\n}\n"],"mappings":";;;;AAeA,MAAM,uCAAuC,IAAI,kCAAgC,IAAI,WACnF,KAAK,UAAU;CACb;CACA,yBAAyB;CAC1B,CAAgD,CAClD,CAAC;AAEF,SAAS,2BACP,SACA;AACA,KACE,QAAQ,eAAA,iCACR,QAAQ,4BAA4B,QACpC,QAAQ,QAAQ,KAAA,KAChB,QAAQ,aAAa,KAAA,EAErB,QAAO;AAGT,QAAO,IAAI,kCAAgC,IAAI,WAAW,KAAK,UAAU,QAAQ,CAAC,CAAC;;AAGrF,SAAgB,oCAAoC,QAAmB;AACrE,KACE,OAAO,OAAO,QAAQ,sBAAsB,cAC5C,CAAC,OAAO,QAAQ,kBAAkB,EAAE,UAAU,OAAO,gBAAgB,CAAC,CAEtE,QAAO;CAGT,MAAM,SAAS,OAAO,QAAQ;AAC9B,KAAI,CAAC,OACH,QAAO;CAGT,MAAM,WAAW,OAAO;CACxB,MAAM,UAAU,OAAO,SAAS;AAGhC,KAAI,YAFe,+BAA+B,SAAS,CAGzD,QAAO;AAGT,QAAO,2BAA2B;EAChC;EACA,yBAAyB;EACzB,KAAK;EACN,CAAC"}
+{"version":3,"file":"server.js","names":[],"sources":["../../../src/scroll-restoration-script/server.ts"],"sourcesContent":["import minifiedScrollRestorationScript from '../scroll-restoration-inline?script-string'\nimport {\n  defaultGetScrollRestorationKey,\n  storageKey,\n} from '../scroll-restoration'\nimport { escapeHtml } from '../utils'\nimport type { AnyRouter } from '../router'\n\nconst defaultInlineScrollRestorationScript = `(${minifiedScrollRestorationScript})(${escapeHtml(\n  JSON.stringify(storageKey),\n)})`\n\nfunction getScrollRestorationScript(key?: string) {\n  if (key === undefined) {\n    return defaultInlineScrollRestorationScript\n  }\n\n  return `(${minifiedScrollRestorationScript})(${escapeHtml(JSON.stringify(storageKey))},${escapeHtml(JSON.stringify(key))})`\n}\n\nexport function getScrollRestorationScriptForRouter(router: AnyRouter) {\n  if (\n    typeof router.options.scrollRestoration === 'function' &&\n    !router.options.scrollRestoration({ location: router.latestLocation })\n  ) {\n    return null\n  }\n\n  const getKey = router.options.getScrollRestorationKey\n  if (!getKey) {\n    return defaultInlineScrollRestorationScript\n  }\n\n  const location = router.latestLocation\n  const userKey = getKey(location)\n  const defaultKey = defaultGetScrollRestorationKey(location)\n\n  if (userKey === defaultKey) {\n    return defaultInlineScrollRestorationScript\n  }\n\n  return getScrollRestorationScript(userKey)\n}\n"],"mappings":";;;;AAQA,MAAM,uCAAuC,IAAI,kCAAgC,IAAI,WACnF,KAAK,UAAU,WAAW,CAC3B,CAAC;AAEF,SAAS,2BAA2B,KAAc;AAChD,KAAI,QAAQ,KAAA,EACV,QAAO;AAGT,QAAO,IAAI,kCAAgC,IAAI,WAAW,KAAK,UAAU,WAAW,CAAC,CAAC,GAAG,WAAW,KAAK,UAAU,IAAI,CAAC,CAAC;;AAG3H,SAAgB,oCAAoC,QAAmB;AACrE,KACE,OAAO,OAAO,QAAQ,sBAAsB,cAC5C,CAAC,OAAO,QAAQ,kBAAkB,EAAE,UAAU,OAAO,gBAAgB,CAAC,CAEtE,QAAO;CAGT,MAAM,SAAS,OAAO,QAAQ;AAC9B,KAAI,CAAC,OACH,QAAO;CAGT,MAAM,WAAW,OAAO;CACxB,MAAM,UAAU,OAAO,SAAS;AAGhC,KAAI,YAFe,+BAA+B,SAAS,CAGzD,QAAO;AAGT,QAAO,2BAA2B,QAAQ"}

package/dist/esm/scroll-restoration.d.ts

@@ -1,23 +1,14 @@
 import { AnyRouter } from './router.js';
 import { ParsedLocation } from './location.js';
-import { NonNullableUpdater } from './utils.js';
 export type ScrollRestorationEntry = {
     scrollX: number;
     scrollY: number;
 };
-type ScrollRestorationByElement = Record<string, ScrollRestorationEntry>;
-type ScrollRestorationByKey = Record<string, ScrollRestorationByElement>;
-type ScrollRestorationCache = {
-    readonly state: ScrollRestorationByKey;
-    set: (updater: NonNullableUpdater<ScrollRestorationByKey>) => void;
-    persist: () => void;
-};
 export type ScrollRestorationOptions = {
     getKey?: (location: ParsedLocation) => string;
     scrollBehavior?: ScrollToOptions['behavior'];
 };
 export declare const storageKey = "tsr-scroll-restoration-v1_3";
-export declare const scrollRestorationCache: ScrollRestorationCache | null;
 /**
  * The default `getKey` function for `useScrollRestoration`.
  * It returns the `key` from the location state or the `href` of the location.
@@ -35,4 +26,3 @@ export declare function getElementScrollRestorationEntry(router: AnyRouter, opti
     getKey?: (location: ParsedLocation) => string;
 }): ScrollRestorationEntry | undefined;
 export declare function setupScrollRestoration(router: AnyRouter, force?: boolean): void;
-export {};

package/dist/esm/scroll-restoration.js

@@ -1,40 +1,31 @@
-import { functionalUpdate, isPlainObject } from "./utils.js";
+import { locationHistoryActions } from "./router.js";
 import { isServer } from "@tanstack/router-core/isServer";
 //#region src/scroll-restoration.ts
 function getSafeSessionStorage() {
 	try {
-		return typeof window !== "undefined" && typeof window.sessionStorage === "object" ? window.sessionStorage : void 0;
+		return sessionStorage;
 	} catch {
 		return;
 	}
 }
 const storageKey = "tsr-scroll-restoration-v1_3";
+const safeSessionStorage = getSafeSessionStorage();
 function createScrollRestorationCache() {
-	const safeSessionStorage = getSafeSessionStorage();
-	if (!safeSessionStorage) return null;
-	let state = {};
 	try {
-		const parsed = JSON.parse(safeSessionStorage.getItem("tsr-scroll-restoration-v1_3") || "{}");
-		if (isPlainObject(parsed)) state = parsed;
-	} catch {}
-	const persist = () => {
-		try {
-			safeSessionStorage.setItem(storageKey, JSON.stringify(state));
-		} catch {
-			if (process.env.NODE_ENV !== "production") console.warn("[ts-router] Could not persist scroll restoration state to sessionStorage.");
-		}
-	};
-	return {
-		get state() {
-			return state;
-		},
-		set: (updater) => {
-			state = functionalUpdate(updater, state) || state;
-		},
-		persist
-	};
+		return JSON.parse(safeSessionStorage?.getItem("tsr-scroll-restoration-v1_3") || "{}");
+	} catch {
+		return {};
+	}
+}
+function persistScrollRestorationCache() {
+	try {
+		safeSessionStorage?.setItem(storageKey, JSON.stringify(scrollRestorationCache));
+	} catch {
+		if (process.env.NODE_ENV !== "production") console.warn("[ts-router] Could not persist scroll restoration state to sessionStorage.");
+	}
 }
-const scrollRestorationCache = createScrollRestorationCache();
+const scrollRestorationCache = /* @__PURE__ */ createScrollRestorationCache();
+const scrollRestorationIdAttribute = "data-scroll-restoration-id";
 /**
 * The default `getKey` function for `useScrollRestoration`.
 * It returns the `key` from the location state or the `href` of the location.
@@ -44,144 +35,160 @@ const scrollRestorationCache = createScrollRestorationCache();
 const defaultGetScrollRestorationKey = (location) => {
 	return location.state.__TSR_key || location.href;
 };
-function getCssSelector(el) {
-	const path = [];
+function getScrollRestorationSelector(element) {
+	const attrId = element.getAttribute(scrollRestorationIdAttribute);
+	if (attrId) return `[${scrollRestorationIdAttribute}="${attrId}"]`;
+	let selector = "";
+	let el = element;
 	let parent;
 	while (parent = el.parentNode) {
-		path.push(`${el.tagName}:nth-child(${Array.prototype.indexOf.call(parent.children, el) + 1})`);
+		let index = 1;
+		let sibling = el;
+		while (sibling = sibling.previousElementSibling) index++;
+		const part = `${el.localName}:nth-child(${index})`;
+		selector = selector ? `${part} > ${selector}` : part;
 		el = parent;
 	}
-	return `${path.reverse().join(" > ")}`.toLowerCase();
+	return selector;
 }
 function getElementScrollRestorationEntry(router, options) {
-	const restoreKey = (options.getKey || defaultGetScrollRestorationKey)(router.latestLocation);
-	if (options.id) return scrollRestorationCache?.state[restoreKey]?.[`[${scrollRestorationIdAttribute}="${options.id}"]`];
+	const entries = scrollRestorationCache[(options.getKey || defaultGetScrollRestorationKey)(router.latestLocation)];
+	if (!entries) return;
+	if (options.id) return entries[`[${scrollRestorationIdAttribute}="${options.id}"]`];
 	const element = options.getElement?.();
 	if (!element) return;
-	return scrollRestorationCache?.state[restoreKey]?.[element instanceof Window ? windowScrollTarget : getCssSelector(element)];
+	return entries[element === window ? windowScrollTarget : getScrollRestorationSelector(element)];
 }
 let ignoreScroll = false;
 const windowScrollTarget = "window";
-const scrollRestorationIdAttribute = "data-scroll-restoration-id";
+function getElement(selector) {
+	try {
+		return typeof selector === "function" ? selector() : document.querySelector(selector);
+	} catch {}
+}
+function getScrollToTopElements(scrollToTopSelectors) {
+	const elements = [];
+	for (const selector of scrollToTopSelectors) {
+		if (selector === windowScrollTarget) continue;
+		const element = getElement(selector);
+		if (element) elements.push(element);
+	}
+	return elements;
+}
 function setupScrollRestoration(router, force) {
-	if (!scrollRestorationCache && !(isServer ?? router.isServer)) return;
-	const cache = scrollRestorationCache;
-	if (force ?? router.options.scrollRestoration ?? false) router.isScrollRestoring = true;
-	if ((isServer ?? router.isServer) || router.isScrollRestorationSetup || !cache) return;
+	if (force ?? router.options.scrollRestoration) router.isScrollRestoring = true;
+	if ((isServer ?? router.isServer) || router.isScrollRestorationSetup) return;
 	router.isScrollRestorationSetup = true;
 	ignoreScroll = false;
 	const getKey = router.options.getScrollRestorationKey || defaultGetScrollRestorationKey;
 	const trackedScrollEntries = /* @__PURE__ */ new Map();
-	window.history.scrollRestoration = "manual";
+	const setTrackedScrollEntry = (target, scrollX, scrollY) => {
+		const entry = trackedScrollEntries.get(target) || {};
+		entry.scrollX = scrollX;
+		entry.scrollY = scrollY;
+		trackedScrollEntries.set(target, entry);
+	};
+	history.scrollRestoration = "manual";
 	const onScroll = (event) => {
 		if (ignoreScroll || !router.isScrollRestoring) return;
-		if (event.target === document || event.target === window) trackedScrollEntries.set(windowScrollTarget, {
-			scrollX: window.scrollX || 0,
-			scrollY: window.scrollY || 0
-		});
+		if (event.target === document) setTrackedScrollEntry(windowScrollTarget, scrollX, scrollY);
 		else {
 			const target = event.target;
-			trackedScrollEntries.set(target, {
-				scrollX: target.scrollLeft || 0,
-				scrollY: target.scrollTop || 0
-			});
+			setTrackedScrollEntry(target, target.scrollLeft, target.scrollTop);
 		}
 	};
 	const snapshotCurrentScrollTargets = (restoreKey) => {
-		if (!router.isScrollRestoring || !restoreKey || trackedScrollEntries.size === 0 || !cache) return;
-		const keyEntry = cache.state[restoreKey] ||= {};
-		for (const [target, position] of trackedScrollEntries) {
-			let selector;
-			if (target === windowScrollTarget) selector = windowScrollTarget;
-			else if (target.isConnected) {
-				const attrId = target.getAttribute(scrollRestorationIdAttribute);
-				selector = attrId ? `[${scrollRestorationIdAttribute}="${attrId}"]` : getCssSelector(target);
-			}
-			if (!selector) continue;
-			keyEntry[selector] = position;
-		}
+		if (!router.isScrollRestoring) return;
+		const keyEntry = scrollRestorationCache[restoreKey] ||= {};
+		for (const [target, position] of trackedScrollEntries) if (target === windowScrollTarget) keyEntry[windowScrollTarget] = position;
+		else if (target.isConnected) keyEntry[getScrollRestorationSelector(target)] = position;
 	};
 	document.addEventListener("scroll", onScroll, true);
 	router.subscribe("onBeforeLoad", (event) => {
-		snapshotCurrentScrollTargets(event.fromLocation ? getKey(event.fromLocation) : void 0);
+		if (event.fromLocation) snapshotCurrentScrollTargets(getKey(event.fromLocation));
 		trackedScrollEntries.clear();
 	});
-	window.addEventListener("pagehide", () => {
+	addEventListener("pagehide", () => {
 		snapshotCurrentScrollTargets(getKey(router.stores.resolvedLocation.get() ?? router.stores.location.get()));
-		cache.persist();
+		persistScrollRestorationCache();
 	});
 	router.subscribe("onRendered", (event) => {
-		const cacheKey = getKey(event.toLocation);
 		const behavior = router.options.scrollRestorationBehavior;
 		const scrollToTopSelectors = router.options.scrollToTopSelectors;
+		const shouldResetScroll = router.resetNextScroll;
+		let scrollToTopElements;
 		trackedScrollEntries.clear();
-		if (!router.resetNextScroll) {
-			router.resetNextScroll = true;
-			return;
-		}
+		if (!shouldResetScroll) router.resetNextScroll = true;
 		if (typeof router.options.scrollRestoration === "function" && !router.options.scrollRestoration({ location: router.latestLocation })) return;
-		ignoreScroll = true;
-		try {
-			const elementEntries = router.isScrollRestoring ? cache.state[cacheKey] : void 0;
-			let restored = false;
-			if (elementEntries) for (const elementSelector in elementEntries) {
-				const entry = elementEntries[elementSelector];
-				if (!isPlainObject(entry)) continue;
-				const { scrollX, scrollY } = entry;
-				if (!Number.isFinite(scrollX) || !Number.isFinite(scrollY)) continue;
-				if (elementSelector === windowScrollTarget) {
-					window.scrollTo({
-						top: scrollY,
-						left: scrollX,
-						behavior
-					});
-					restored = true;
-				} else if (elementSelector) {
-					let element;
-					try {
-						element = document.querySelector(elementSelector);
-					} catch {
-						continue;
-					}
-					if (element) {
-						element.scrollLeft = scrollX;
-						element.scrollTop = scrollY;
-						restored = true;
+		const cacheKey = getKey(event.toLocation);
+		const fromCacheKey = event.fromLocation && getKey(event.fromLocation);
+		if (router.isScrollRestoring && fromCacheKey && fromCacheKey !== cacheKey) {
+			const fromElementEntries = scrollRestorationCache[fromCacheKey];
+			if (fromElementEntries) {
+				let toElementEntries = scrollRestorationCache[cacheKey];
+				for (const elementSelector in fromElementEntries) {
+					if (elementSelector === windowScrollTarget) {
+						if (shouldResetScroll) continue;
+					} else {
+						const element = getElement(elementSelector);
+						if (!element) continue;
+						if (shouldResetScroll && scrollToTopSelectors) {
+							scrollToTopElements ??= getScrollToTopElements(scrollToTopSelectors);
+							if (scrollToTopElements.includes(element)) continue;
+						}
 					}
+					if (!toElementEntries) toElementEntries = scrollRestorationCache[cacheKey] = {};
+					toElementEntries[elementSelector] ??= fromElementEntries[elementSelector];
 				}
 			}
-			if (!restored) {
-				const hash = router.history.location.hash.slice(1);
-				if (hash) {
-					const hashScrollIntoViewOptions = window.history.state?.__hashScrollIntoViewOptions ?? true;
-					if (hashScrollIntoViewOptions) {
-						const el = document.getElementById(hash);
-						if (el) el.scrollIntoView(hashScrollIntoViewOptions);
+		}
+		ignoreScroll = true;
+		try {
+			const hash = event.toLocation.hash;
+			const hashScrollIntoViewOptions = event.toLocation.state.__hashScrollIntoViewOptions ?? true;
+			let windowRestored = false;
+			if (shouldResetScroll) {
+				const action = locationHistoryActions.get(event.toLocation);
+				const skipWindowRestore = hash && hashScrollIntoViewOptions && (action === "PUSH" || action === "REPLACE");
+				const elementEntries = router.isScrollRestoring ? scrollRestorationCache[cacheKey] : void 0;
+				if (elementEntries) for (const elementSelector in elementEntries) {
+					const { scrollX, scrollY } = elementEntries[elementSelector];
+					if (elementSelector === windowScrollTarget) {
+						if (skipWindowRestore) continue;
+						scrollTo({
+							top: scrollY,
+							left: scrollX,
+							behavior
+						});
+						windowRestored = true;
+					} else {
+						const element = getElement(elementSelector);
+						if (element) {
+							element.scrollLeft = scrollX;
+							element.scrollTop = scrollY;
+						}
 					}
-				} else {
+				}
+				if (!windowRestored && !hash) {
 					const scrollOptions = {
 						top: 0,
 						left: 0,
 						behavior
 					};
-					window.scrollTo(scrollOptions);
-					if (scrollToTopSelectors) for (const selector of scrollToTopSelectors) {
-						if (selector === windowScrollTarget) continue;
-						const element = typeof selector === "function" ? selector() : document.querySelector(selector);
-						if (element) element.scrollTo(scrollOptions);
+					scrollTo(scrollOptions);
+					if (scrollToTopSelectors) {
+						scrollToTopElements ??= getScrollToTopElements(scrollToTopSelectors);
+						for (const element of scrollToTopElements) element.scrollTo(scrollOptions);
 					}
 				}
 			}
+			if (!windowRestored && hash && hashScrollIntoViewOptions) document.getElementById(hash)?.scrollIntoView(hashScrollIntoViewOptions);
 		} finally {
 			ignoreScroll = false;
 		}
-		if (router.isScrollRestoring) cache.set((state) => {
-			state[cacheKey] ||= {};
-			return state;
-		});
 	});
 }
 //#endregion
-export { defaultGetScrollRestorationKey, getElementScrollRestorationEntry, scrollRestorationCache, setupScrollRestoration, storageKey };
+export { defaultGetScrollRestorationKey, getElementScrollRestorationEntry, setupScrollRestoration, storageKey };
 
 //# sourceMappingURL=scroll-restoration.js.map

package/dist/esm/scroll-restoration.js.map

@@ -1 +1 @@
-{"version":3,"file":"scroll-restoration.js","names":[],"sources":["../../src/scroll-restoration.ts"],"sourcesContent":["import { isServer } from '@tanstack/router-core/isServer'\nimport { functionalUpdate, isPlainObject } from './utils'\nimport type { AnyRouter } from './router'\nimport type { ParsedLocation } from './location'\nimport type { NonNullableUpdater } from './utils'\n\nexport type ScrollRestorationEntry = { scrollX: number; scrollY: number }\n\ntype ScrollRestorationByElement = Record<string, ScrollRestorationEntry>\n\ntype ScrollRestorationByKey = Record<string, ScrollRestorationByElement>\n\ntype ScrollRestorationCache = {\n  readonly state: ScrollRestorationByKey\n  set: (updater: NonNullableUpdater<ScrollRestorationByKey>) => void\n  persist: () => void\n}\n\nexport type ScrollRestorationOptions = {\n  getKey?: (location: ParsedLocation) => string\n  scrollBehavior?: ScrollToOptions['behavior']\n}\n\nfunction getSafeSessionStorage() {\n  try {\n    return typeof window !== 'undefined' &&\n      typeof window.sessionStorage === 'object'\n      ? window.sessionStorage\n      : undefined\n  } catch {\n    // silent\n    return undefined\n  }\n}\n\n// SessionStorage key used to store scroll positions across navigations.\nexport const storageKey = 'tsr-scroll-restoration-v1_3'\n\nfunction createScrollRestorationCache(): ScrollRestorationCache | null {\n  const safeSessionStorage = getSafeSessionStorage()\n  if (!safeSessionStorage) {\n    return null\n  }\n\n  let state: ScrollRestorationByKey = {}\n\n  try {\n    const parsed = JSON.parse(safeSessionStorage.getItem(storageKey) || '{}')\n    if (isPlainObject(parsed)) {\n      state = parsed as ScrollRestorationByKey\n    }\n  } catch {\n    // ignore invalid session storage payloads\n  }\n\n  const persist = () => {\n    try {\n      safeSessionStorage.setItem(storageKey, JSON.stringify(state))\n    } catch {\n      if (process.env.NODE_ENV !== 'production') {\n        console.warn(\n          '[ts-router] Could not persist scroll restoration state to sessionStorage.',\n        )\n      }\n    }\n  }\n\n  return {\n    get state() {\n      return state\n    },\n    set: (updater) => {\n      state = functionalUpdate(updater, state) || state\n    },\n    persist,\n  }\n}\n\nexport const scrollRestorationCache = createScrollRestorationCache()\n\n/**\n * The default `getKey` function for `useScrollRestoration`.\n * It returns the `key` from the location state or the `href` of the location.\n *\n * The `location.href` is used as a fallback to support the use case where the location state is not available like the initial render.\n */\nexport const defaultGetScrollRestorationKey = (location: ParsedLocation) => {\n  return location.state.__TSR_key! || location.href\n}\n\nfunction getCssSelector(el: any): string {\n  const path = []\n  let parent: HTMLElement\n  while ((parent = el.parentNode)) {\n    path.push(\n      `${el.tagName}:nth-child(${Array.prototype.indexOf.call(parent.children, el) + 1})`,\n    )\n    el = parent\n  }\n  return `${path.reverse().join(' > ')}`.toLowerCase()\n}\n\nexport function getElementScrollRestorationEntry(\n  router: AnyRouter,\n  options: (\n    | {\n        id: string\n        getElement?: () => Window | Element | undefined | null\n      }\n    | {\n        id?: string\n        getElement: () => Window | Element | undefined | null\n      }\n  ) & {\n    getKey?: (location: ParsedLocation) => string\n  },\n): ScrollRestorationEntry | undefined {\n  const getKey = options.getKey || defaultGetScrollRestorationKey\n  const restoreKey = getKey(router.latestLocation)\n\n  if (options.id) {\n    return scrollRestorationCache?.state[restoreKey]?.[\n      `[${scrollRestorationIdAttribute}=\"${options.id}\"]`\n    ]\n  }\n\n  const element = options.getElement?.()\n  if (!element) {\n    return\n  }\n\n  return scrollRestorationCache?.state[restoreKey]?.[\n    element instanceof Window ? windowScrollTarget : getCssSelector(element)\n  ]\n}\n\nlet ignoreScroll = false\nconst windowScrollTarget = 'window'\nconst scrollRestorationIdAttribute = 'data-scroll-restoration-id'\ntype ScrollTarget = typeof windowScrollTarget | Element\n\nexport function setupScrollRestoration(router: AnyRouter, force?: boolean) {\n  if (!scrollRestorationCache && !(isServer ?? router.isServer)) {\n    return\n  }\n\n  const cache = scrollRestorationCache\n\n  const shouldScrollRestoration =\n    force ?? router.options.scrollRestoration ?? false\n\n  if (shouldScrollRestoration) {\n    router.isScrollRestoring = true\n  }\n\n  if (\n    (isServer ?? router.isServer) ||\n    router.isScrollRestorationSetup ||\n    !cache\n  ) {\n    return\n  }\n\n  router.isScrollRestorationSetup = true\n  ignoreScroll = false\n\n  const getKey =\n    router.options.getScrollRestorationKey || defaultGetScrollRestorationKey\n  const trackedScrollEntries = new Map<ScrollTarget, ScrollRestorationEntry>()\n\n  window.history.scrollRestoration = 'manual'\n\n  const onScroll = (event: Event) => {\n    if (ignoreScroll || !router.isScrollRestoring) {\n      return\n    }\n\n    if (event.target === document || event.target === window) {\n      trackedScrollEntries.set(windowScrollTarget, {\n        scrollX: window.scrollX || 0,\n        scrollY: window.scrollY || 0,\n      })\n    } else {\n      const target = event.target as Element\n      trackedScrollEntries.set(target, {\n        scrollX: target.scrollLeft || 0,\n        scrollY: target.scrollTop || 0,\n      })\n    }\n  }\n\n  // Snapshot the current page's tracked scroll targets before navigation or unload.\n  const snapshotCurrentScrollTargets = (restoreKey?: string) => {\n    if (\n      !router.isScrollRestoring ||\n      !restoreKey ||\n      trackedScrollEntries.size === 0 ||\n      !cache\n    ) {\n      return\n    }\n\n    const keyEntry = (cache.state[restoreKey] ||=\n      {} as ScrollRestorationByElement)\n\n    for (const [target, position] of trackedScrollEntries) {\n      let selector: string | undefined\n\n      if (target === windowScrollTarget) {\n        selector = windowScrollTarget\n      } else if (target.isConnected) {\n        const attrId = target.getAttribute(scrollRestorationIdAttribute)\n        selector = attrId\n          ? `[${scrollRestorationIdAttribute}=\"${attrId}\"]`\n          : getCssSelector(target)\n      }\n\n      if (!selector) {\n        continue\n      }\n\n      keyEntry[selector] = position\n    }\n  }\n\n  document.addEventListener('scroll', onScroll, true)\n  router.subscribe('onBeforeLoad', (event) => {\n    snapshotCurrentScrollTargets(\n      event.fromLocation ? getKey(event.fromLocation) : undefined,\n    )\n    trackedScrollEntries.clear()\n  })\n  window.addEventListener('pagehide', () => {\n    snapshotCurrentScrollTargets(\n      getKey(\n        router.stores.resolvedLocation.get() ?? router.stores.location.get(),\n      ),\n    )\n    cache.persist()\n  })\n\n  // Restore destination scroll after the new route has rendered.\n  router.subscribe('onRendered', (event) => {\n    const cacheKey = getKey(event.toLocation)\n    const behavior = router.options.scrollRestorationBehavior\n    const scrollToTopSelectors = router.options.scrollToTopSelectors\n    trackedScrollEntries.clear()\n\n    if (!router.resetNextScroll) {\n      router.resetNextScroll = true\n      return\n    }\n\n    if (\n      typeof router.options.scrollRestoration === 'function' &&\n      !router.options.scrollRestoration({ location: router.latestLocation })\n    ) {\n      return\n    }\n\n    ignoreScroll = true\n\n    try {\n      const elementEntries = router.isScrollRestoring\n        ? cache.state[cacheKey]\n        : undefined\n      let restored = false\n\n      if (elementEntries) {\n        for (const elementSelector in elementEntries) {\n          const entry = elementEntries[elementSelector]\n\n          if (!isPlainObject(entry)) {\n            continue\n          }\n\n          const { scrollX, scrollY } = entry as {\n            scrollX?: unknown\n            scrollY?: unknown\n          }\n\n          if (!Number.isFinite(scrollX) || !Number.isFinite(scrollY)) {\n            continue\n          }\n\n          if (elementSelector === windowScrollTarget) {\n            window.scrollTo({\n              top: scrollY as number,\n              left: scrollX as number,\n              behavior,\n            })\n            restored = true\n          } else if (elementSelector) {\n            let element\n\n            try {\n              element = document.querySelector(elementSelector)\n            } catch {\n              continue\n            }\n\n            if (element) {\n              element.scrollLeft = scrollX as number\n              element.scrollTop = scrollY as number\n              restored = true\n            }\n          }\n        }\n      }\n\n      if (!restored) {\n        const hash = router.history.location.hash.slice(1)\n\n        if (hash) {\n          const hashScrollIntoViewOptions =\n            window.history.state?.__hashScrollIntoViewOptions ?? true\n\n          if (hashScrollIntoViewOptions) {\n            const el = document.getElementById(hash)\n            if (el) {\n              el.scrollIntoView(hashScrollIntoViewOptions)\n            }\n          }\n        } else {\n          const scrollOptions = {\n            top: 0,\n            left: 0,\n            behavior,\n          }\n\n          window.scrollTo(scrollOptions)\n          if (scrollToTopSelectors) {\n            for (const selector of scrollToTopSelectors) {\n              if (selector === windowScrollTarget) continue\n              const element =\n                typeof selector === 'function'\n                  ? selector()\n                  : document.querySelector(selector)\n              if (element) {\n                element.scrollTo(scrollOptions)\n              }\n            }\n          }\n        }\n      }\n    } finally {\n      ignoreScroll = false\n    }\n\n    if (router.isScrollRestoring) {\n      cache.set((state) => {\n        state[cacheKey] ||= {} as ScrollRestorationByElement\n        return state\n      })\n    }\n  })\n}\n"],"mappings":";;;AAuBA,SAAS,wBAAwB;AAC/B,KAAI;AACF,SAAO,OAAO,WAAW,eACvB,OAAO,OAAO,mBAAmB,WAC/B,OAAO,iBACP,KAAA;SACE;AAEN;;;AAKJ,MAAa,aAAa;AAE1B,SAAS,+BAA8D;CACrE,MAAM,qBAAqB,uBAAuB;AAClD,KAAI,CAAC,mBACH,QAAO;CAGT,IAAI,QAAgC,EAAE;AAEtC,KAAI;EACF,MAAM,SAAS,KAAK,MAAM,mBAAmB,QAAA,8BAAmB,IAAI,KAAK;AACzE,MAAI,cAAc,OAAO,CACvB,SAAQ;SAEJ;CAIR,MAAM,gBAAgB;AACpB,MAAI;AACF,sBAAmB,QAAQ,YAAY,KAAK,UAAU,MAAM,CAAC;UACvD;AACN,OAAA,QAAA,IAAA,aAA6B,aAC3B,SAAQ,KACN,4EACD;;;AAKP,QAAO;EACL,IAAI,QAAQ;AACV,UAAO;;EAET,MAAM,YAAY;AAChB,WAAQ,iBAAiB,SAAS,MAAM,IAAI;;EAE9C;EACD;;AAGH,MAAa,yBAAyB,8BAA8B;;;;;;;AAQpE,MAAa,kCAAkC,aAA6B;AAC1E,QAAO,SAAS,MAAM,aAAc,SAAS;;AAG/C,SAAS,eAAe,IAAiB;CACvC,MAAM,OAAO,EAAE;CACf,IAAI;AACJ,QAAQ,SAAS,GAAG,YAAa;AAC/B,OAAK,KACH,GAAG,GAAG,QAAQ,aAAa,MAAM,UAAU,QAAQ,KAAK,OAAO,UAAU,GAAG,GAAG,EAAE,GAClF;AACD,OAAK;;AAEP,QAAO,GAAG,KAAK,SAAS,CAAC,KAAK,MAAM,GAAG,aAAa;;AAGtD,SAAgB,iCACd,QACA,SAYoC;CAEpC,MAAM,cADS,QAAQ,UAAU,gCACP,OAAO,eAAe;AAEhD,KAAI,QAAQ,GACV,QAAO,wBAAwB,MAAM,cACnC,IAAI,6BAA6B,IAAI,QAAQ,GAAG;CAIpD,MAAM,UAAU,QAAQ,cAAc;AACtC,KAAI,CAAC,QACH;AAGF,QAAO,wBAAwB,MAAM,cACnC,mBAAmB,SAAS,qBAAqB,eAAe,QAAQ;;AAI5E,IAAI,eAAe;AACnB,MAAM,qBAAqB;AAC3B,MAAM,+BAA+B;AAGrC,SAAgB,uBAAuB,QAAmB,OAAiB;AACzE,KAAI,CAAC,0BAA0B,EAAE,YAAY,OAAO,UAClD;CAGF,MAAM,QAAQ;AAKd,KAFE,SAAS,OAAO,QAAQ,qBAAqB,MAG7C,QAAO,oBAAoB;AAG7B,MACG,YAAY,OAAO,aACpB,OAAO,4BACP,CAAC,MAED;AAGF,QAAO,2BAA2B;AAClC,gBAAe;CAEf,MAAM,SACJ,OAAO,QAAQ,2BAA2B;CAC5C,MAAM,uCAAuB,IAAI,KAA2C;AAE5E,QAAO,QAAQ,oBAAoB;CAEnC,MAAM,YAAY,UAAiB;AACjC,MAAI,gBAAgB,CAAC,OAAO,kBAC1B;AAGF,MAAI,MAAM,WAAW,YAAY,MAAM,WAAW,OAChD,sBAAqB,IAAI,oBAAoB;GAC3C,SAAS,OAAO,WAAW;GAC3B,SAAS,OAAO,WAAW;GAC5B,CAAC;OACG;GACL,MAAM,SAAS,MAAM;AACrB,wBAAqB,IAAI,QAAQ;IAC/B,SAAS,OAAO,cAAc;IAC9B,SAAS,OAAO,aAAa;IAC9B,CAAC;;;CAKN,MAAM,gCAAgC,eAAwB;AAC5D,MACE,CAAC,OAAO,qBACR,CAAC,cACD,qBAAqB,SAAS,KAC9B,CAAC,MAED;EAGF,MAAM,WAAY,MAAM,MAAM,gBAC5B,EAAE;AAEJ,OAAK,MAAM,CAAC,QAAQ,aAAa,sBAAsB;GACrD,IAAI;AAEJ,OAAI,WAAW,mBACb,YAAW;YACF,OAAO,aAAa;IAC7B,MAAM,SAAS,OAAO,aAAa,6BAA6B;AAChE,eAAW,SACP,IAAI,6BAA6B,IAAI,OAAO,MAC5C,eAAe,OAAO;;AAG5B,OAAI,CAAC,SACH;AAGF,YAAS,YAAY;;;AAIzB,UAAS,iBAAiB,UAAU,UAAU,KAAK;AACnD,QAAO,UAAU,iBAAiB,UAAU;AAC1C,+BACE,MAAM,eAAe,OAAO,MAAM,aAAa,GAAG,KAAA,EACnD;AACD,uBAAqB,OAAO;GAC5B;AACF,QAAO,iBAAiB,kBAAkB;AACxC,+BACE,OACE,OAAO,OAAO,iBAAiB,KAAK,IAAI,OAAO,OAAO,SAAS,KAAK,CACrE,CACF;AACD,QAAM,SAAS;GACf;AAGF,QAAO,UAAU,eAAe,UAAU;EACxC,MAAM,WAAW,OAAO,MAAM,WAAW;EACzC,MAAM,WAAW,OAAO,QAAQ;EAChC,MAAM,uBAAuB,OAAO,QAAQ;AAC5C,uBAAqB,OAAO;AAE5B,MAAI,CAAC,OAAO,iBAAiB;AAC3B,UAAO,kBAAkB;AACzB;;AAGF,MACE,OAAO,OAAO,QAAQ,sBAAsB,cAC5C,CAAC,OAAO,QAAQ,kBAAkB,EAAE,UAAU,OAAO,gBAAgB,CAAC,CAEtE;AAGF,iBAAe;AAEf,MAAI;GACF,MAAM,iBAAiB,OAAO,oBAC1B,MAAM,MAAM,YACZ,KAAA;GACJ,IAAI,WAAW;AAEf,OAAI,eACF,MAAK,MAAM,mBAAmB,gBAAgB;IAC5C,MAAM,QAAQ,eAAe;AAE7B,QAAI,CAAC,cAAc,MAAM,CACvB;IAGF,MAAM,EAAE,SAAS,YAAY;AAK7B,QAAI,CAAC,OAAO,SAAS,QAAQ,IAAI,CAAC,OAAO,SAAS,QAAQ,CACxD;AAGF,QAAI,oBAAoB,oBAAoB;AAC1C,YAAO,SAAS;MACd,KAAK;MACL,MAAM;MACN;MACD,CAAC;AACF,gBAAW;eACF,iBAAiB;KAC1B,IAAI;AAEJ,SAAI;AACF,gBAAU,SAAS,cAAc,gBAAgB;aAC3C;AACN;;AAGF,SAAI,SAAS;AACX,cAAQ,aAAa;AACrB,cAAQ,YAAY;AACpB,iBAAW;;;;AAMnB,OAAI,CAAC,UAAU;IACb,MAAM,OAAO,OAAO,QAAQ,SAAS,KAAK,MAAM,EAAE;AAElD,QAAI,MAAM;KACR,MAAM,4BACJ,OAAO,QAAQ,OAAO,+BAA+B;AAEvD,SAAI,2BAA2B;MAC7B,MAAM,KAAK,SAAS,eAAe,KAAK;AACxC,UAAI,GACF,IAAG,eAAe,0BAA0B;;WAG3C;KACL,MAAM,gBAAgB;MACpB,KAAK;MACL,MAAM;MACN;MACD;AAED,YAAO,SAAS,cAAc;AAC9B,SAAI,qBACF,MAAK,MAAM,YAAY,sBAAsB;AAC3C,UAAI,aAAa,mBAAoB;MACrC,MAAM,UACJ,OAAO,aAAa,aAChB,UAAU,GACV,SAAS,cAAc,SAAS;AACtC,UAAI,QACF,SAAQ,SAAS,cAAc;;;;YAMjC;AACR,kBAAe;;AAGjB,MAAI,OAAO,kBACT,OAAM,KAAK,UAAU;AACnB,SAAM,cAAc,EAAE;AACtB,UAAO;IACP;GAEJ"}
+{"version":3,"file":"scroll-restoration.js","names":[],"sources":["../../src/scroll-restoration.ts"],"sourcesContent":["import { isServer } from '@tanstack/router-core/isServer'\nimport { locationHistoryActions } from './router'\nimport type { AnyRouter } from './router'\nimport type { ParsedLocation } from './location'\n\nexport type ScrollRestorationEntry = { scrollX: number; scrollY: number }\n\ntype ScrollRestorationByElement = Record<string, ScrollRestorationEntry>\n\ntype ScrollRestorationByKey = Record<string, ScrollRestorationByElement>\n\nexport type ScrollRestorationOptions = {\n  getKey?: (location: ParsedLocation) => string\n  scrollBehavior?: ScrollToOptions['behavior']\n}\n\nfunction getSafeSessionStorage() {\n  try {\n    // Accessing sessionStorage itself can throw SecurityError in locked-down\n    // contexts, e.g. sandboxed/opaque origins or blocked storage policies.\n    return sessionStorage\n  } catch {\n    return\n  }\n}\n\n// SessionStorage key used to store scroll positions across navigations.\nexport const storageKey = 'tsr-scroll-restoration-v1_3'\nconst safeSessionStorage = getSafeSessionStorage()\n\nfunction createScrollRestorationCache() {\n  try {\n    return JSON.parse(\n      safeSessionStorage?.getItem(storageKey) || '{}',\n    ) as ScrollRestorationByKey\n  } catch {\n    // ignore invalid session storage payloads\n    return {}\n  }\n}\n\nfunction persistScrollRestorationCache() {\n  try {\n    safeSessionStorage?.setItem(\n      storageKey,\n      JSON.stringify(scrollRestorationCache),\n    )\n  } catch {\n    if (process.env.NODE_ENV !== 'production') {\n      console.warn(\n        '[ts-router] Could not persist scroll restoration state to sessionStorage.',\n      )\n    }\n  }\n}\n\nconst scrollRestorationCache = /* @__PURE__ */ createScrollRestorationCache()\nconst scrollRestorationIdAttribute = 'data-scroll-restoration-id'\n\n/**\n * The default `getKey` function for `useScrollRestoration`.\n * It returns the `key` from the location state or the `href` of the location.\n *\n * The `location.href` is used as a fallback to support the use case where the location state is not available like the initial render.\n */\nexport const defaultGetScrollRestorationKey = (location: ParsedLocation) => {\n  return location.state.__TSR_key! || location.href\n}\n\nfunction getScrollRestorationSelector(element: Element): string {\n  const attrId = element.getAttribute(scrollRestorationIdAttribute)\n  if (attrId) {\n    return `[${scrollRestorationIdAttribute}=\"${attrId}\"]`\n  }\n\n  let selector = ''\n  let el: any = element\n  let parent: HTMLElement\n\n  while ((parent = el.parentNode)) {\n    let index = 1\n    let sibling = el\n    while ((sibling = sibling.previousElementSibling)) {\n      index++\n    }\n\n    const part = `${el.localName}:nth-child(${index})`\n    selector = selector ? `${part} > ${selector}` : part\n    el = parent\n  }\n\n  return selector\n}\n\nexport function getElementScrollRestorationEntry(\n  router: AnyRouter,\n  options: (\n    | {\n        id: string\n        getElement?: () => Window | Element | undefined | null\n      }\n    | {\n        id?: string\n        getElement: () => Window | Element | undefined | null\n      }\n  ) & {\n    getKey?: (location: ParsedLocation) => string\n  },\n): ScrollRestorationEntry | undefined {\n  const getKey = options.getKey || defaultGetScrollRestorationKey\n  const restoreKey = getKey(router.latestLocation)\n  const entries = scrollRestorationCache[restoreKey]\n\n  if (!entries) {\n    return\n  }\n\n  if (options.id) {\n    return entries[`[${scrollRestorationIdAttribute}=\"${options.id}\"]`]\n  }\n\n  const element = options.getElement?.()\n  if (!element) {\n    return\n  }\n\n  return entries[\n    element === window\n      ? windowScrollTarget\n      : getScrollRestorationSelector(element as Element)\n  ]\n}\n\nlet ignoreScroll = false\nconst windowScrollTarget = 'window'\ntype ScrollTarget = typeof windowScrollTarget | Element\n\nfunction getElement(selector: string | (() => Element | null | undefined)) {\n  try {\n    return typeof selector === 'function'\n      ? selector()\n      : document.querySelector(selector)\n  } catch {}\n  return\n}\n\nfunction getScrollToTopElements(\n  scrollToTopSelectors: NonNullable<\n    AnyRouter['options']['scrollToTopSelectors']\n  >,\n): Array<Element> {\n  const elements: Array<Element> = []\n\n  for (const selector of scrollToTopSelectors) {\n    if (selector === windowScrollTarget) {\n      continue\n    }\n\n    const element = getElement(selector)\n    if (element) {\n      elements.push(element)\n    }\n  }\n\n  return elements\n}\n\nexport function setupScrollRestoration(router: AnyRouter, force?: boolean) {\n  // Keep hash/top scrolling active even when sessionStorage is unavailable.\n\n  if (force ?? router.options.scrollRestoration) {\n    router.isScrollRestoring = true\n  }\n\n  if ((isServer ?? router.isServer) || router.isScrollRestorationSetup) {\n    return\n  }\n\n  router.isScrollRestorationSetup = true\n  ignoreScroll = false\n\n  const getKey =\n    router.options.getScrollRestorationKey || defaultGetScrollRestorationKey\n  const trackedScrollEntries = new Map<ScrollTarget, ScrollRestorationEntry>()\n  const setTrackedScrollEntry = (\n    target: ScrollTarget,\n    scrollX: number,\n    scrollY: number,\n  ) => {\n    const entry =\n      trackedScrollEntries.get(target) || ({} as ScrollRestorationEntry)\n    entry.scrollX = scrollX\n    entry.scrollY = scrollY\n    trackedScrollEntries.set(target, entry)\n  }\n\n  history.scrollRestoration = 'manual'\n\n  const onScroll = (event: Event) => {\n    if (ignoreScroll || !router.isScrollRestoring) {\n      return\n    }\n\n    if (event.target === document) {\n      setTrackedScrollEntry(windowScrollTarget, scrollX, scrollY)\n    } else {\n      const target = event.target as Element\n      setTrackedScrollEntry(target, target.scrollLeft, target.scrollTop)\n    }\n  }\n\n  // Snapshot the current page's tracked scroll targets before navigation or unload.\n  const snapshotCurrentScrollTargets = (restoreKey: string) => {\n    if (!router.isScrollRestoring) {\n      return\n    }\n\n    const keyEntry = (scrollRestorationCache[restoreKey] ||=\n      {} as ScrollRestorationByElement)\n\n    for (const [target, position] of trackedScrollEntries) {\n      if (target === windowScrollTarget) {\n        keyEntry[windowScrollTarget] = position\n      } else if (target.isConnected) {\n        keyEntry[getScrollRestorationSelector(target)] = position\n      }\n    }\n  }\n\n  document.addEventListener('scroll', onScroll, true)\n  router.subscribe('onBeforeLoad', (event) => {\n    if (event.fromLocation) {\n      snapshotCurrentScrollTargets(getKey(event.fromLocation))\n    }\n    trackedScrollEntries.clear()\n  })\n  addEventListener('pagehide', () => {\n    snapshotCurrentScrollTargets(\n      getKey(\n        router.stores.resolvedLocation.get() ?? router.stores.location.get(),\n      ),\n    )\n    persistScrollRestorationCache()\n  })\n\n  // Restore destination scroll after the new route has rendered.\n  router.subscribe('onRendered', (event) => {\n    const behavior = router.options.scrollRestorationBehavior\n    const scrollToTopSelectors = router.options.scrollToTopSelectors\n    const shouldResetScroll = router.resetNextScroll\n    let scrollToTopElements: Array<Element> | undefined\n    trackedScrollEntries.clear()\n\n    if (!shouldResetScroll) {\n      router.resetNextScroll = true\n    }\n\n    if (\n      typeof router.options.scrollRestoration === 'function' &&\n      !router.options.scrollRestoration({ location: router.latestLocation })\n    ) {\n      return\n    }\n\n    const cacheKey = getKey(event.toLocation)\n    const fromCacheKey = event.fromLocation && getKey(event.fromLocation)\n\n    if (router.isScrollRestoring && fromCacheKey && fromCacheKey !== cacheKey) {\n      const fromElementEntries = scrollRestorationCache[fromCacheKey]\n\n      if (fromElementEntries) {\n        let toElementEntries = scrollRestorationCache[cacheKey]\n\n        for (const elementSelector in fromElementEntries) {\n          if (elementSelector === windowScrollTarget) {\n            if (shouldResetScroll) {\n              continue\n            }\n          } else {\n            const element = getElement(elementSelector)\n            if (!element) {\n              continue\n            }\n\n            if (shouldResetScroll && scrollToTopSelectors) {\n              scrollToTopElements ??=\n                getScrollToTopElements(scrollToTopSelectors)\n              if (scrollToTopElements.includes(element)) {\n                continue\n              }\n            }\n          }\n\n          if (!toElementEntries) {\n            toElementEntries = scrollRestorationCache[cacheKey] =\n              {} as ScrollRestorationByElement\n          }\n\n          toElementEntries[elementSelector] ??=\n            fromElementEntries[elementSelector]!\n        }\n      }\n    }\n\n    ignoreScroll = true\n\n    try {\n      const hash = event.toLocation.hash\n      const hashScrollIntoViewOptions =\n        event.toLocation.state.__hashScrollIntoViewOptions ?? true\n      let windowRestored = false\n\n      if (shouldResetScroll) {\n        const action = locationHistoryActions.get(event.toLocation)\n        const skipWindowRestore =\n          hash &&\n          hashScrollIntoViewOptions &&\n          (action === 'PUSH' || action === 'REPLACE')\n\n        const elementEntries = router.isScrollRestoring\n          ? scrollRestorationCache[cacheKey]\n          : undefined\n\n        if (elementEntries) {\n          for (const elementSelector in elementEntries) {\n            const { scrollX, scrollY } = elementEntries[elementSelector]!\n\n            if (elementSelector === windowScrollTarget) {\n              if (skipWindowRestore) {\n                continue\n              }\n\n              scrollTo({\n                top: scrollY,\n                left: scrollX,\n                behavior,\n              })\n              windowRestored = true\n            } else {\n              const element = getElement(elementSelector)\n              if (element) {\n                element.scrollLeft = scrollX\n                element.scrollTop = scrollY\n              }\n            }\n          }\n        }\n\n        if (!windowRestored && !hash) {\n          const scrollOptions = {\n            top: 0,\n            left: 0,\n            behavior,\n          }\n\n          scrollTo(scrollOptions)\n          if (scrollToTopSelectors) {\n            scrollToTopElements ??= getScrollToTopElements(scrollToTopSelectors)\n            for (const element of scrollToTopElements) {\n              element.scrollTo(scrollOptions)\n            }\n          }\n        }\n      }\n\n      if (!windowRestored && hash && hashScrollIntoViewOptions) {\n        document.getElementById(hash)?.scrollIntoView(hashScrollIntoViewOptions)\n      }\n    } finally {\n      ignoreScroll = false\n    }\n  })\n}\n"],"mappings":";;;AAgBA,SAAS,wBAAwB;AAC/B,KAAI;AAGF,SAAO;SACD;AACN;;;AAKJ,MAAa,aAAa;AAC1B,MAAM,qBAAqB,uBAAuB;AAElD,SAAS,+BAA+B;AACtC,KAAI;AACF,SAAO,KAAK,MACV,oBAAoB,QAAA,8BAAmB,IAAI,KAC5C;SACK;AAEN,SAAO,EAAE;;;AAIb,SAAS,gCAAgC;AACvC,KAAI;AACF,sBAAoB,QAClB,YACA,KAAK,UAAU,uBAAuB,CACvC;SACK;AACN,MAAA,QAAA,IAAA,aAA6B,aAC3B,SAAQ,KACN,4EACD;;;AAKP,MAAM,yBAAyC,8CAA8B;AAC7E,MAAM,+BAA+B;;;;;;;AAQrC,MAAa,kCAAkC,aAA6B;AAC1E,QAAO,SAAS,MAAM,aAAc,SAAS;;AAG/C,SAAS,6BAA6B,SAA0B;CAC9D,MAAM,SAAS,QAAQ,aAAa,6BAA6B;AACjE,KAAI,OACF,QAAO,IAAI,6BAA6B,IAAI,OAAO;CAGrD,IAAI,WAAW;CACf,IAAI,KAAU;CACd,IAAI;AAEJ,QAAQ,SAAS,GAAG,YAAa;EAC/B,IAAI,QAAQ;EACZ,IAAI,UAAU;AACd,SAAQ,UAAU,QAAQ,uBACxB;EAGF,MAAM,OAAO,GAAG,GAAG,UAAU,aAAa,MAAM;AAChD,aAAW,WAAW,GAAG,KAAK,KAAK,aAAa;AAChD,OAAK;;AAGP,QAAO;;AAGT,SAAgB,iCACd,QACA,SAYoC;CAGpC,MAAM,UAAU,wBAFD,QAAQ,UAAU,gCACP,OAAO,eAAe;AAGhD,KAAI,CAAC,QACH;AAGF,KAAI,QAAQ,GACV,QAAO,QAAQ,IAAI,6BAA6B,IAAI,QAAQ,GAAG;CAGjE,MAAM,UAAU,QAAQ,cAAc;AACtC,KAAI,CAAC,QACH;AAGF,QAAO,QACL,YAAY,SACR,qBACA,6BAA6B,QAAmB;;AAIxD,IAAI,eAAe;AACnB,MAAM,qBAAqB;AAG3B,SAAS,WAAW,UAAuD;AACzE,KAAI;AACF,SAAO,OAAO,aAAa,aACvB,UAAU,GACV,SAAS,cAAc,SAAS;SAC9B;;AAIV,SAAS,uBACP,sBAGgB;CAChB,MAAM,WAA2B,EAAE;AAEnC,MAAK,MAAM,YAAY,sBAAsB;AAC3C,MAAI,aAAa,mBACf;EAGF,MAAM,UAAU,WAAW,SAAS;AACpC,MAAI,QACF,UAAS,KAAK,QAAQ;;AAI1B,QAAO;;AAGT,SAAgB,uBAAuB,QAAmB,OAAiB;AAGzE,KAAI,SAAS,OAAO,QAAQ,kBAC1B,QAAO,oBAAoB;AAG7B,MAAK,YAAY,OAAO,aAAa,OAAO,yBAC1C;AAGF,QAAO,2BAA2B;AAClC,gBAAe;CAEf,MAAM,SACJ,OAAO,QAAQ,2BAA2B;CAC5C,MAAM,uCAAuB,IAAI,KAA2C;CAC5E,MAAM,yBACJ,QACA,SACA,YACG;EACH,MAAM,QACJ,qBAAqB,IAAI,OAAO,IAAK,EAAE;AACzC,QAAM,UAAU;AAChB,QAAM,UAAU;AAChB,uBAAqB,IAAI,QAAQ,MAAM;;AAGzC,SAAQ,oBAAoB;CAE5B,MAAM,YAAY,UAAiB;AACjC,MAAI,gBAAgB,CAAC,OAAO,kBAC1B;AAGF,MAAI,MAAM,WAAW,SACnB,uBAAsB,oBAAoB,SAAS,QAAQ;OACtD;GACL,MAAM,SAAS,MAAM;AACrB,yBAAsB,QAAQ,OAAO,YAAY,OAAO,UAAU;;;CAKtE,MAAM,gCAAgC,eAAuB;AAC3D,MAAI,CAAC,OAAO,kBACV;EAGF,MAAM,WAAY,uBAAuB,gBACvC,EAAE;AAEJ,OAAK,MAAM,CAAC,QAAQ,aAAa,qBAC/B,KAAI,WAAW,mBACb,UAAS,sBAAsB;WACtB,OAAO,YAChB,UAAS,6BAA6B,OAAO,IAAI;;AAKvD,UAAS,iBAAiB,UAAU,UAAU,KAAK;AACnD,QAAO,UAAU,iBAAiB,UAAU;AAC1C,MAAI,MAAM,aACR,8BAA6B,OAAO,MAAM,aAAa,CAAC;AAE1D,uBAAqB,OAAO;GAC5B;AACF,kBAAiB,kBAAkB;AACjC,+BACE,OACE,OAAO,OAAO,iBAAiB,KAAK,IAAI,OAAO,OAAO,SAAS,KAAK,CACrE,CACF;AACD,iCAA+B;GAC/B;AAGF,QAAO,UAAU,eAAe,UAAU;EACxC,MAAM,WAAW,OAAO,QAAQ;EAChC,MAAM,uBAAuB,OAAO,QAAQ;EAC5C,MAAM,oBAAoB,OAAO;EACjC,IAAI;AACJ,uBAAqB,OAAO;AAE5B,MAAI,CAAC,kBACH,QAAO,kBAAkB;AAG3B,MACE,OAAO,OAAO,QAAQ,sBAAsB,cAC5C,CAAC,OAAO,QAAQ,kBAAkB,EAAE,UAAU,OAAO,gBAAgB,CAAC,CAEtE;EAGF,MAAM,WAAW,OAAO,MAAM,WAAW;EACzC,MAAM,eAAe,MAAM,gBAAgB,OAAO,MAAM,aAAa;AAErE,MAAI,OAAO,qBAAqB,gBAAgB,iBAAiB,UAAU;GACzE,MAAM,qBAAqB,uBAAuB;AAElD,OAAI,oBAAoB;IACtB,IAAI,mBAAmB,uBAAuB;AAE9C,SAAK,MAAM,mBAAmB,oBAAoB;AAChD,SAAI,oBAAoB;UAClB,kBACF;YAEG;MACL,MAAM,UAAU,WAAW,gBAAgB;AAC3C,UAAI,CAAC,QACH;AAGF,UAAI,qBAAqB,sBAAsB;AAC7C,+BACE,uBAAuB,qBAAqB;AAC9C,WAAI,oBAAoB,SAAS,QAAQ,CACvC;;;AAKN,SAAI,CAAC,iBACH,oBAAmB,uBAAuB,YACxC,EAAE;AAGN,sBAAiB,qBACf,mBAAmB;;;;AAK3B,iBAAe;AAEf,MAAI;GACF,MAAM,OAAO,MAAM,WAAW;GAC9B,MAAM,4BACJ,MAAM,WAAW,MAAM,+BAA+B;GACxD,IAAI,iBAAiB;AAErB,OAAI,mBAAmB;IACrB,MAAM,SAAS,uBAAuB,IAAI,MAAM,WAAW;IAC3D,MAAM,oBACJ,QACA,8BACC,WAAW,UAAU,WAAW;IAEnC,MAAM,iBAAiB,OAAO,oBAC1B,uBAAuB,YACvB,KAAA;AAEJ,QAAI,eACF,MAAK,MAAM,mBAAmB,gBAAgB;KAC5C,MAAM,EAAE,SAAS,YAAY,eAAe;AAE5C,SAAI,oBAAoB,oBAAoB;AAC1C,UAAI,kBACF;AAGF,eAAS;OACP,KAAK;OACL,MAAM;OACN;OACD,CAAC;AACF,uBAAiB;YACZ;MACL,MAAM,UAAU,WAAW,gBAAgB;AAC3C,UAAI,SAAS;AACX,eAAQ,aAAa;AACrB,eAAQ,YAAY;;;;AAM5B,QAAI,CAAC,kBAAkB,CAAC,MAAM;KAC5B,MAAM,gBAAgB;MACpB,KAAK;MACL,MAAM;MACN;MACD;AAED,cAAS,cAAc;AACvB,SAAI,sBAAsB;AACxB,8BAAwB,uBAAuB,qBAAqB;AACpE,WAAK,MAAM,WAAW,oBACpB,SAAQ,SAAS,cAAc;;;;AAMvC,OAAI,CAAC,kBAAkB,QAAQ,0BAC7B,UAAS,eAAe,KAAK,EAAE,eAAe,0BAA0B;YAElE;AACR,kBAAe;;GAEjB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/router-core",
-  "version": "1.171.3",
+  "version": "1.171.5",
   "description": "Modern and scalable routing for React applications",
   "author": "Tanner Linsley",
   "license": "MIT",

package/src/index.ts

@@ -407,12 +407,9 @@ export {
   defaultGetScrollRestorationKey,
   getElementScrollRestorationEntry,
   storageKey,
-  scrollRestorationCache,
   setupScrollRestoration,
 } from './scroll-restoration'
 
-export { handleHashScroll } from './hash-scroll'
-
 export type {
   ScrollRestorationOptions,
   ScrollRestorationEntry,

package/src/rewrite.ts

@@ -1,7 +1,6 @@
 import { joinPaths, trimPath } from './path'
 import type { LocationRewrite } from './router'
 
-/** Compose multiple rewrite pairs into a single in/out rewrite. */
 /** Compose multiple rewrite pairs into a single in/out rewrite. */
 export function composeRewrites(rewrites: Array<LocationRewrite>) {
   return {
@@ -20,7 +19,6 @@ export function composeRewrites(rewrites: Array<LocationRewrite>) {
   } satisfies LocationRewrite
 }
 
-/** Create a rewrite pair that strips/adds a basepath on input/output. */
 /** Create a rewrite pair that strips/adds a basepath on input/output. */
 export function rewriteBasepath(opts: {
   basepath: string
@@ -28,13 +26,10 @@ export function rewriteBasepath(opts: {
 }) {
   const trimmedBasepath = trimPath(opts.basepath)
   const normalizedBasepath = `/${trimmedBasepath}`
-  const normalizedBasepathWithSlash = `${normalizedBasepath}/`
   const checkBasepath = opts.caseSensitive
     ? normalizedBasepath
     : normalizedBasepath.toLowerCase()
-  const checkBasepathWithSlash = opts.caseSensitive
-    ? normalizedBasepathWithSlash
-    : normalizedBasepathWithSlash.toLowerCase()
+  const checkBasepathWithSlash = `${checkBasepath}/`
 
   return {
     input: ({ url }) => {
@@ -58,7 +53,6 @@ export function rewriteBasepath(opts: {
   } satisfies LocationRewrite
 }
 
-/** Execute a location input rewrite if provided. */
 /** Execute a location input rewrite if provided. */
 export function executeRewriteInput(
   rewrite: LocationRewrite | undefined,
@@ -75,7 +69,6 @@ export function executeRewriteInput(
   return url
 }
 
-/** Execute a location output rewrite if provided. */
 /** Execute a location output rewrite if provided. */
 export function executeRewriteOutput(
   rewrite: LocationRewrite | undefined,

package/src/router.ts

@@ -52,6 +52,7 @@ import type {
 import type { SearchParser, SearchSerializer } from './searchParams'
 import type { AnyRedirect, ResolvedRedirect } from './redirect'
 import type {
+  HistoryAction,
   HistoryLocation,
   HistoryState,
   ParsedHistoryState,
@@ -740,7 +741,10 @@ export type GetMatchRoutesFn = (pathname: string) => {
 
 export type EmitFn = (routerEvent: RouterEvent) => void
 
-export type LoadFn = (opts?: { sync?: boolean }) => Promise<void>
+export type LoadFn = (opts?: {
+  sync?: boolean
+  action?: { type: HistoryAction }
+}) => Promise<void>
 
 export type CommitLocationFn = ({
   viewTransition,
@@ -883,6 +887,11 @@ export function getLocationChangeInfo(
   return { fromLocation, toLocation, pathChanged, hrefChanged, hashChanged }
 }
 
+export const locationHistoryActions = new WeakMap<
+  ParsedLocation,
+  HistoryAction
+>()
+
 export type CreateRouterFn = <
   TRouteTree extends AnyRoute,
   TTrailingSlashOption extends TrailingSlashOption = 'never',
@@ -2116,6 +2125,7 @@ export class RouterCore<
     ignoreBlocker,
     ...next
   }) => {
+    let historyAction: HistoryAction | undefined
     const isSameState = () => {
       // the following props are ignored but may still be provided when navigating,
       // temporarily add the previous values to the next state so they don't affect
@@ -2191,7 +2201,9 @@ export class RouterCore<
 
       this.shouldViewTransition = viewTransition
 
-      this.history[next.replace ? 'replace' : 'push'](
+      historyAction = next.replace ? 'REPLACE' : 'PUSH'
+
+      this.history[historyAction === 'REPLACE' ? 'replace' : 'push'](
         nextHistory.publicHref,
         nextHistory.state,
         { ignoreBlocker },
@@ -2201,7 +2213,13 @@ export class RouterCore<
     this.resetNextScroll = next.resetScroll ?? true
 
     if (!this.history.subscribers.size) {
-      this.load()
+      this.load(
+        historyAction
+          ? {
+              action: { type: historyAction },
+            }
+          : undefined,
+      )
     }
 
     return this.commitLocationPromise
@@ -2403,7 +2421,8 @@ export class RouterCore<
     })
   }
 
-  load: LoadFn = async (opts?: { sync?: boolean }): Promise<void> => {
+  load: LoadFn = async (opts): Promise<void> => {
+    const historyAction = opts?.action?.type
     let redirect: AnyRedirect | undefined
     let notFound: NotFoundError | undefined
     let loadPromise: Promise<void>
@@ -2415,6 +2434,11 @@ export class RouterCore<
       this.startTransition(async () => {
         try {
           this.beforeLoad()
+          if (historyAction) {
+            locationHistoryActions.set(this.latestLocation, historyAction)
+          } else {
+            locationHistoryActions.delete(this.latestLocation)
+          }
           const next = this.latestLocation
           const prevLocation = this.stores.resolvedLocation.get()
           const locationChangeInfo = getLocationChangeInfo(next, prevLocation)