@tanstack/router-core 1.168.4 → 1.168.5

package/dist/esm/scroll-restoration.js

@@ -1,42 +1,39 @@
-import { functionalUpdate } from "./utils.js";
+import { functionalUpdate, isPlainObject } from "./utils.js";
 import { isServer } from "@tanstack/router-core/isServer";
 //#region src/scroll-restoration.ts
 function getSafeSessionStorage() {
 	try {
-		if (typeof window !== "undefined" && typeof window.sessionStorage === "object") return window.sessionStorage;
-	} catch {}
+		return typeof window !== "undefined" && typeof window.sessionStorage === "object" ? window.sessionStorage : void 0;
+	} catch {
+		return;
+	}
 }
-/** SessionStorage key used to persist scroll restoration state. */
-/** SessionStorage key used to store scroll positions across navigations. */
-/** SessionStorage key used to store scroll positions across navigations. */
 var storageKey = "tsr-scroll-restoration-v1_3";
-var throttle = (fn, wait) => {
-	let timeout;
-	return (...args) => {
-		if (!timeout) timeout = setTimeout(() => {
-			fn(...args);
-			timeout = null;
-		}, wait);
-	};
-};
 function createScrollRestorationCache() {
 	const safeSessionStorage = getSafeSessionStorage();
 	if (!safeSessionStorage) return null;
-	const persistedState = safeSessionStorage.getItem(storageKey);
-	let state = persistedState ? JSON.parse(persistedState) : {};
+	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 {
-		state,
+		get state() {
+			return state;
+		},
 		set: (updater) => {
 			state = functionalUpdate(updater, state) || state;
-			try {
-				safeSessionStorage.setItem(storageKey, JSON.stringify(state));
-			} catch {
-				console.warn("[ts-router] Could not persist scroll restoration state to sessionStorage.");
-			}
-		}
+		},
+		persist
 	};
 }
-/** In-memory handle to the persisted scroll restoration cache. */
 var scrollRestorationCache = createScrollRestorationCache();
 /**
 * The default `getKey` function for `useScrollRestoration`.
@@ -44,13 +41,9 @@ var scrollRestorationCache = createScrollRestorationCache();
 *
 * The `location.href` is used as a fallback to support the use case where the location state is not available like the initial render.
 */
-/**
-* Default scroll restoration cache key: location state key or full href.
-*/
 var defaultGetScrollRestorationKey = (location) => {
 	return location.state.__TSR_key || location.href;
 };
-/** Best-effort nth-child CSS selector for a given element. */
 function getCssSelector(el) {
 	const path = [];
 	let parent;
@@ -60,144 +53,141 @@ function getCssSelector(el) {
 	}
 	return `${path.reverse().join(" > ")}`.toLowerCase();
 }
-var ignoreScroll = false;
-function restoreScroll({ storageKey, key, behavior, shouldScrollRestoration, scrollToTopSelectors, location }) {
-	let byKey;
-	try {
-		byKey = JSON.parse(sessionStorage.getItem(storageKey) || "{}");
-	} catch (error) {
-		console.error(error);
-		return;
-	}
-	const resolvedKey = key || window.history.state?.__TSR_key;
-	const elementEntries = byKey[resolvedKey];
-	ignoreScroll = true;
-	scroll: {
-		if (shouldScrollRestoration && elementEntries && Object.keys(elementEntries).length > 0) {
-			for (const elementSelector in elementEntries) {
-				const entry = elementEntries[elementSelector];
-				if (elementSelector === "window") window.scrollTo({
-					top: entry.scrollY,
-					left: entry.scrollX,
-					behavior
-				});
-				else if (elementSelector) {
-					const element = document.querySelector(elementSelector);
-					if (element) {
-						element.scrollLeft = entry.scrollX;
-						element.scrollTop = entry.scrollY;
-					}
-				}
-			}
-			break scroll;
-		}
-		const hash = (location ?? window.location).hash.split("#", 2)[1];
-		if (hash) {
-			const hashScrollIntoViewOptions = window.history.state?.__hashScrollIntoViewOptions ?? true;
-			if (hashScrollIntoViewOptions) {
-				const el = document.getElementById(hash);
-				if (el) el.scrollIntoView(hashScrollIntoViewOptions);
-			}
-			break scroll;
-		}
-		const scrollOptions = {
-			top: 0,
-			left: 0,
-			behavior
-		};
-		window.scrollTo(scrollOptions);
-		if (scrollToTopSelectors) for (const selector of scrollToTopSelectors) {
-			if (selector === "window") continue;
-			const element = typeof selector === "function" ? selector() : document.querySelector(selector);
-			if (element) element.scrollTo(scrollOptions);
-		}
-	}
-	ignoreScroll = false;
+function getElementScrollRestorationEntry(router, options) {
+	const restoreKey = (options.getKey || defaultGetScrollRestorationKey)(router.latestLocation);
+	if (options.id) return scrollRestorationCache?.state[restoreKey]?.[`[${scrollRestorationIdAttribute}="${options.id}"]`];
+	const element = options.getElement?.();
+	if (!element) return;
+	return scrollRestorationCache?.state[restoreKey]?.[element instanceof Window ? windowScrollTarget : getCssSelector(element)];
 }
-/** Setup global listeners and hooks to support scroll restoration. */
-/** Setup global listeners and hooks to support scroll restoration. */
+var ignoreScroll = false;
+var windowScrollTarget = "window";
+var scrollRestorationIdAttribute = "data-scroll-restoration-id";
 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 || !scrollRestorationCache) return;
+	if ((isServer ?? router.isServer) || router.isScrollRestorationSetup || !cache) return;
 	router.isScrollRestorationSetup = true;
 	ignoreScroll = false;
 	const getKey = router.options.getScrollRestorationKey || defaultGetScrollRestorationKey;
+	const trackedScrollEntries = /* @__PURE__ */ new Map();
 	window.history.scrollRestoration = "manual";
 	const onScroll = (event) => {
 		if (ignoreScroll || !router.isScrollRestoring) return;
-		let elementSelector = "";
-		if (event.target === document || event.target === window) elementSelector = "window";
+		if (event.target === document || event.target === window) trackedScrollEntries.set(windowScrollTarget, {
+			scrollX: window.scrollX || 0,
+			scrollY: window.scrollY || 0
+		});
 		else {
-			const attrId = event.target.getAttribute("data-scroll-restoration-id");
-			if (attrId) elementSelector = `[data-scroll-restoration-id="${attrId}"]`;
-			else elementSelector = getCssSelector(event.target);
+			const target = event.target;
+			trackedScrollEntries.set(target, {
+				scrollX: target.scrollLeft || 0,
+				scrollY: target.scrollTop || 0
+			});
 		}
-		const restoreKey = getKey(router.stores.location.state);
-		scrollRestorationCache.set((state) => {
-			const keyEntry = state[restoreKey] ||= {};
-			const elementEntry = keyEntry[elementSelector] ||= {};
-			if (elementSelector === "window") {
-				elementEntry.scrollX = window.scrollX || 0;
-				elementEntry.scrollY = window.scrollY || 0;
-			} else if (elementSelector) {
-				const element = document.querySelector(elementSelector);
-				if (element) {
-					elementEntry.scrollX = element.scrollLeft || 0;
-					elementEntry.scrollY = element.scrollTop || 0;
-				}
+	};
+	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);
 			}
-			return state;
-		});
+			if (!selector) continue;
+			keyEntry[selector] = position;
+		}
 	};
-	if (typeof document !== "undefined") document.addEventListener("scroll", throttle(onScroll, 100), true);
+	document.addEventListener("scroll", onScroll, true);
+	router.subscribe("onBeforeLoad", (event) => {
+		snapshotCurrentScrollTargets(event.fromLocation ? getKey(event.fromLocation) : void 0);
+		trackedScrollEntries.clear();
+	});
+	window.addEventListener("pagehide", () => {
+		snapshotCurrentScrollTargets(getKey(router.stores.resolvedLocation.state ?? router.stores.location.state));
+		cache.persist();
+	});
 	router.subscribe("onRendered", (event) => {
 		const cacheKey = getKey(event.toLocation);
+		const behavior = router.options.scrollRestorationBehavior;
+		const scrollToTopSelectors = router.options.scrollToTopSelectors;
+		trackedScrollEntries.clear();
 		if (!router.resetNextScroll) {
 			router.resetNextScroll = true;
 			return;
 		}
-		if (typeof router.options.scrollRestoration === "function") {
-			if (!router.options.scrollRestoration({ location: router.latestLocation })) return;
-		}
-		restoreScroll({
-			storageKey,
-			key: cacheKey,
-			behavior: router.options.scrollRestorationBehavior,
-			shouldScrollRestoration: router.isScrollRestoring,
-			scrollToTopSelectors: router.options.scrollToTopSelectors,
-			location: router.history.location
+		if (typeof router.options.scrollRestoration === "function" && !router.options.scrollRestoration({ location: router.latestLocation })) return;
+		const fromIndex = event.fromLocation?.state.__TSR_index;
+		const toIndex = event.toLocation.state.__TSR_index;
+		if (typeof fromIndex === "number" && typeof toIndex === "number" ? toIndex > fromIndex || toIndex === fromIndex && event.fromLocation?.href !== event.toLocation.href : true) cache.set((state) => {
+			delete state[cacheKey];
+			return state;
 		});
-		if (router.isScrollRestoring) scrollRestorationCache.set((state) => {
+		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;
+					}
+				}
+			}
+			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);
+					}
+				} else {
+					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);
+					}
+				}
+			}
+		} finally {
+			ignoreScroll = false;
+		}
+		if (router.isScrollRestoring) cache.set((state) => {
 			state[cacheKey] ||= {};
 			return state;
 		});
 	});
 }
-/**
-* @private
-* Handles hash-based scrolling after navigation completes.
-* To be used in framework-specific <Transitioner> components during the onResolved event.
-*
-* Provides hash scrolling for programmatic navigation when default browser handling is prevented.
-* @param router The router instance containing current location and state
-*/
-/**
-* @private
-* Handles hash-based scrolling after navigation completes.
-* To be used in framework-specific Transitioners.
-*/
-function handleHashScroll(router) {
-	if (typeof document !== "undefined" && document.querySelector) {
-		const location = router.stores.location.state;
-		const hashScrollIntoViewOptions = location.state.__hashScrollIntoViewOptions ?? true;
-		if (hashScrollIntoViewOptions && location.hash !== "") {
-			const el = document.getElementById(location.hash);
-			if (el) el.scrollIntoView(hashScrollIntoViewOptions);
-		}
-	}
-}
 //#endregion
-export { defaultGetScrollRestorationKey, getCssSelector, handleHashScroll, restoreScroll, scrollRestorationCache, setupScrollRestoration, storageKey };
+export { defaultGetScrollRestorationKey, getElementScrollRestorationEntry, scrollRestorationCache, 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 } from './utils'\nimport type { AnyRouter } from './router'\nimport type { ParsedLocation } from './location'\nimport type { NonNullableUpdater } from './utils'\nimport type { HistoryLocation } from '@tanstack/history'\n\nexport type ScrollRestorationEntry = { scrollX: number; scrollY: number }\n\nexport type ScrollRestorationByElement = Record<string, ScrollRestorationEntry>\n\nexport type ScrollRestorationByKey = Record<string, ScrollRestorationByElement>\n\nexport type ScrollRestorationCache = {\n  state: ScrollRestorationByKey\n  set: (updater: NonNullableUpdater<ScrollRestorationByKey>) => void\n}\nexport type ScrollRestorationOptions = {\n  getKey?: (location: ParsedLocation) => string\n  scrollBehavior?: ScrollToOptions['behavior']\n}\n\nfunction getSafeSessionStorage() {\n  try {\n    if (\n      typeof window !== 'undefined' &&\n      typeof window.sessionStorage === 'object'\n    ) {\n      return window.sessionStorage\n    }\n  } catch {\n    // silent\n  }\n  return undefined\n}\n\n/** SessionStorage key used to persist scroll restoration state. */\n/** SessionStorage key used to store scroll positions across navigations. */\n/** SessionStorage key used to store scroll positions across navigations. */\nexport const storageKey = 'tsr-scroll-restoration-v1_3'\n\nconst throttle = (fn: (...args: Array<any>) => void, wait: number) => {\n  let timeout: any\n  return (...args: Array<any>) => {\n    if (!timeout) {\n      timeout = setTimeout(() => {\n        fn(...args)\n        timeout = null\n      }, wait)\n    }\n  }\n}\n\nfunction createScrollRestorationCache(): ScrollRestorationCache | null {\n  const safeSessionStorage = getSafeSessionStorage()\n  if (!safeSessionStorage) {\n    return null\n  }\n\n  const persistedState = safeSessionStorage.getItem(storageKey)\n  let state: ScrollRestorationByKey = persistedState\n    ? JSON.parse(persistedState)\n    : {}\n\n  return {\n    state,\n    // This setter is simply to make sure that we set the sessionStorage right\n    // after the state is updated. It doesn't necessarily need to be a functional\n    // update.\n    set: (updater) => {\n      state = functionalUpdate(updater, state) || state\n      try {\n        safeSessionStorage.setItem(storageKey, JSON.stringify(state))\n      } catch {\n        console.warn(\n          '[ts-router] Could not persist scroll restoration state to sessionStorage.',\n        )\n      }\n    },\n  }\n}\n\n/** In-memory handle to the persisted scroll restoration cache. */\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 */\n\n/**\n * Default scroll restoration cache key: location state key or full href.\n */\nexport const defaultGetScrollRestorationKey = (location: ParsedLocation) => {\n  return location.state.__TSR_key! || location.href\n}\n\n/** Best-effort nth-child CSS selector for a given element. */\nexport function 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\nlet ignoreScroll = false\n\n// NOTE: This function must remain pure and not use any outside variables\n// unless they are passed in as arguments. Why? Because we need to be able to\n// toString() it into a script tag to execute as early as possible in the browser\n// during SSR. Additionally, we also call it from within the router lifecycle\nexport function restoreScroll({\n  storageKey,\n  key,\n  behavior,\n  shouldScrollRestoration,\n  scrollToTopSelectors,\n  location,\n}: {\n  storageKey: string\n  key?: string\n  behavior?: ScrollToOptions['behavior']\n  shouldScrollRestoration?: boolean\n  scrollToTopSelectors?: Array<string | (() => Element | null | undefined)>\n  location?: HistoryLocation\n}) {\n  let byKey: ScrollRestorationByKey\n\n  try {\n    byKey = JSON.parse(sessionStorage.getItem(storageKey) || '{}')\n  } catch (error) {\n    console.error(error)\n    return\n  }\n\n  const resolvedKey = key || window.history.state?.__TSR_key\n  const elementEntries = byKey[resolvedKey]\n\n  //\n  ignoreScroll = true\n\n  //\n  scroll: {\n    // If we have a cached entry for this location state,\n    // we always need to prefer that over the hash scroll.\n    if (\n      shouldScrollRestoration &&\n      elementEntries &&\n      Object.keys(elementEntries).length > 0\n    ) {\n      for (const elementSelector in elementEntries) {\n        const entry = elementEntries[elementSelector]!\n        if (elementSelector === 'window') {\n          window.scrollTo({\n            top: entry.scrollY,\n            left: entry.scrollX,\n            behavior,\n          })\n        } else if (elementSelector) {\n          const element = document.querySelector(elementSelector)\n          if (element) {\n            element.scrollLeft = entry.scrollX\n            element.scrollTop = entry.scrollY\n          }\n        }\n      }\n\n      break scroll\n    }\n\n    // If we don't have a cached entry for the hash,\n    // Which means we've never seen this location before,\n    // we need to check if there is a hash in the URL.\n    // If there is, we need to scroll it's ID into view.\n    const hash = (location ?? 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      break scroll\n    }\n\n    // If there is no cached entry for the hash and there is no hash in the URL,\n    // we need to scroll to the top of the page for every scrollToTop element\n    const scrollOptions = { top: 0, left: 0, behavior }\n    window.scrollTo(scrollOptions)\n    if (scrollToTopSelectors) {\n      for (const selector of scrollToTopSelectors) {\n        if (selector === 'window') continue\n        const element =\n          typeof selector === 'function'\n            ? selector()\n            : document.querySelector(selector)\n        if (element) element.scrollTo(scrollOptions)\n      }\n    }\n  }\n\n  //\n  ignoreScroll = false\n}\n\n/** Setup global listeners and hooks to support scroll restoration. */\n/** Setup global listeners and hooks to support scroll restoration. */\nexport function setupScrollRestoration(router: AnyRouter, force?: boolean) {\n  if (!scrollRestorationCache && !(isServer ?? router.isServer)) {\n    return\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    !scrollRestorationCache\n  ) {\n    return\n  }\n\n  router.isScrollRestorationSetup = true\n\n  //\n  ignoreScroll = false\n\n  const getKey =\n    router.options.getScrollRestorationKey || defaultGetScrollRestorationKey\n\n  window.history.scrollRestoration = 'manual'\n\n  // // Create a MutationObserver to monitor DOM changes\n  // const mutationObserver = new MutationObserver(() => {\n  //   ;ignoreScroll = true\n  //   requestAnimationFrame(() => {\n  //     ;ignoreScroll = false\n\n  //     // Attempt to restore scroll position on each dom\n  //     // mutation until the user scrolls. We do this\n  //     // because dynamic content may come in at different\n  //     // ticks after the initial render and we want to\n  //     // keep up with that content as much as possible.\n  //     // As soon as the user scrolls, we no longer need\n  //     // to attempt router.\n  //     // console.log('mutation observer restoreScroll')\n  //     restoreScroll(\n  //       storageKey,\n  //       getKey(router.stores.location.state),\n  //       router.options.scrollRestorationBehavior,\n  //     )\n  //   })\n  // })\n\n  // const observeDom = () => {\n  //   // Observe changes to the entire document\n  //   mutationObserver.observe(document, {\n  //     childList: true, // Detect added or removed child nodes\n  //     subtree: true, // Monitor all descendants\n  //     characterData: true, // Detect text content changes\n  //   })\n  // }\n\n  // const unobserveDom = () => {\n  //   mutationObserver.disconnect()\n  // }\n\n  // observeDom()\n\n  const onScroll = (event: Event) => {\n    // unobserveDom()\n\n    if (ignoreScroll || !router.isScrollRestoring) {\n      return\n    }\n\n    let elementSelector = ''\n\n    if (event.target === document || event.target === window) {\n      elementSelector = 'window'\n    } else {\n      const attrId = (event.target as Element).getAttribute(\n        'data-scroll-restoration-id',\n      )\n\n      if (attrId) {\n        elementSelector = `[data-scroll-restoration-id=\"${attrId}\"]`\n      } else {\n        elementSelector = getCssSelector(event.target)\n      }\n    }\n\n    const restoreKey = getKey(router.stores.location.state)\n\n    scrollRestorationCache.set((state) => {\n      const keyEntry = (state[restoreKey] ||= {} as ScrollRestorationByElement)\n\n      const elementEntry = (keyEntry[elementSelector] ||=\n        {} as ScrollRestorationEntry)\n\n      if (elementSelector === 'window') {\n        elementEntry.scrollX = window.scrollX || 0\n        elementEntry.scrollY = window.scrollY || 0\n      } else if (elementSelector) {\n        const element = document.querySelector(elementSelector)\n        if (element) {\n          elementEntry.scrollX = element.scrollLeft || 0\n          elementEntry.scrollY = element.scrollTop || 0\n        }\n      }\n\n      return state\n    })\n  }\n\n  // Throttle the scroll event to avoid excessive updates\n  if (typeof document !== 'undefined') {\n    document.addEventListener('scroll', throttle(onScroll, 100), true)\n  }\n\n  router.subscribe('onRendered', (event) => {\n    // unobserveDom()\n\n    const cacheKey = getKey(event.toLocation)\n\n    // If the user doesn't want to restore the scroll position,\n    // we don't need to do anything.\n    if (!router.resetNextScroll) {\n      router.resetNextScroll = true\n      return\n    }\n    if (typeof router.options.scrollRestoration === 'function') {\n      const shouldRestore = router.options.scrollRestoration({\n        location: router.latestLocation,\n      })\n      if (!shouldRestore) {\n        return\n      }\n    }\n\n    restoreScroll({\n      storageKey,\n      key: cacheKey,\n      behavior: router.options.scrollRestorationBehavior,\n      shouldScrollRestoration: router.isScrollRestoring,\n      scrollToTopSelectors: router.options.scrollToTopSelectors,\n      location: router.history.location,\n    })\n\n    if (router.isScrollRestoring) {\n      // Mark the location as having been seen\n      scrollRestorationCache.set((state) => {\n        state[cacheKey] ||= {} as ScrollRestorationByElement\n\n        return state\n      })\n    }\n  })\n}\n\n/**\n * @private\n * Handles hash-based scrolling after navigation completes.\n * To be used in framework-specific <Transitioner> components during the onResolved event.\n *\n * Provides hash scrolling for programmatic navigation when default browser handling is prevented.\n * @param router The router instance containing current location and state\n */\n/**\n * @private\n * Handles hash-based scrolling after navigation completes.\n * To be used in framework-specific Transitioners.\n */\nexport function handleHashScroll(router: AnyRouter) {\n  if (typeof document !== 'undefined' && (document as any).querySelector) {\n    const location = router.stores.location.state\n    const hashScrollIntoViewOptions =\n      location.state.__hashScrollIntoViewOptions ?? true\n\n    if (hashScrollIntoViewOptions && location.hash !== '') {\n      const el = document.getElementById(location.hash)\n      if (el) {\n        el.scrollIntoView(hashScrollIntoViewOptions)\n      }\n    }\n  }\n}\n"],"mappings":";;;AAsBA,SAAS,wBAAwB;AAC/B,KAAI;AACF,MACE,OAAO,WAAW,eAClB,OAAO,OAAO,mBAAmB,SAEjC,QAAO,OAAO;SAEV;;;;;AASV,IAAa,aAAa;AAE1B,IAAM,YAAY,IAAmC,SAAiB;CACpE,IAAI;AACJ,SAAQ,GAAG,SAAqB;AAC9B,MAAI,CAAC,QACH,WAAU,iBAAiB;AACzB,MAAG,GAAG,KAAK;AACX,aAAU;KACT,KAAK;;;AAKd,SAAS,+BAA8D;CACrE,MAAM,qBAAqB,uBAAuB;AAClD,KAAI,CAAC,mBACH,QAAO;CAGT,MAAM,iBAAiB,mBAAmB,QAAQ,WAAW;CAC7D,IAAI,QAAgC,iBAChC,KAAK,MAAM,eAAe,GAC1B,EAAE;AAEN,QAAO;EACL;EAIA,MAAM,YAAY;AAChB,WAAQ,iBAAiB,SAAS,MAAM,IAAI;AAC5C,OAAI;AACF,uBAAmB,QAAQ,YAAY,KAAK,UAAU,MAAM,CAAC;WACvD;AACN,YAAQ,KACN,4EACD;;;EAGN;;;AAIH,IAAa,yBAAyB,8BAA8B;;;;;;;;;;AAYpE,IAAa,kCAAkC,aAA6B;AAC1E,QAAO,SAAS,MAAM,aAAc,SAAS;;;AAI/C,SAAgB,eAAe,IAAiB;CAC9C,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,IAAI,eAAe;AAMnB,SAAgB,cAAc,EAC5B,YACA,KACA,UACA,yBACA,sBACA,YAQC;CACD,IAAI;AAEJ,KAAI;AACF,UAAQ,KAAK,MAAM,eAAe,QAAQ,WAAW,IAAI,KAAK;UACvD,OAAO;AACd,UAAQ,MAAM,MAAM;AACpB;;CAGF,MAAM,cAAc,OAAO,OAAO,QAAQ,OAAO;CACjD,MAAM,iBAAiB,MAAM;AAG7B,gBAAe;AAGf,SAAQ;AAGN,MACE,2BACA,kBACA,OAAO,KAAK,eAAe,CAAC,SAAS,GACrC;AACA,QAAK,MAAM,mBAAmB,gBAAgB;IAC5C,MAAM,QAAQ,eAAe;AAC7B,QAAI,oBAAoB,SACtB,QAAO,SAAS;KACd,KAAK,MAAM;KACX,MAAM,MAAM;KACZ;KACD,CAAC;aACO,iBAAiB;KAC1B,MAAM,UAAU,SAAS,cAAc,gBAAgB;AACvD,SAAI,SAAS;AACX,cAAQ,aAAa,MAAM;AAC3B,cAAQ,YAAY,MAAM;;;;AAKhC,SAAM;;EAOR,MAAM,QAAQ,YAAY,OAAO,UAAU,KAAK,MAAM,KAAK,EAAE,CAAC;AAE9D,MAAI,MAAM;GACR,MAAM,4BACJ,OAAO,QAAQ,OAAO,+BAA+B;AAEvD,OAAI,2BAA2B;IAC7B,MAAM,KAAK,SAAS,eAAe,KAAK;AACxC,QAAI,GACF,IAAG,eAAe,0BAA0B;;AAIhD,SAAM;;EAKR,MAAM,gBAAgB;GAAE,KAAK;GAAG,MAAM;GAAG;GAAU;AACnD,SAAO,SAAS,cAAc;AAC9B,MAAI,qBACF,MAAK,MAAM,YAAY,sBAAsB;AAC3C,OAAI,aAAa,SAAU;GAC3B,MAAM,UACJ,OAAO,aAAa,aAChB,UAAU,GACV,SAAS,cAAc,SAAS;AACtC,OAAI,QAAS,SAAQ,SAAS,cAAc;;;AAMlD,gBAAe;;;;AAKjB,SAAgB,uBAAuB,QAAmB,OAAiB;AACzE,KAAI,CAAC,0BAA0B,EAAE,YAAY,OAAO,UAClD;AAKF,KAFE,SAAS,OAAO,QAAQ,qBAAqB,MAG7C,QAAO,oBAAoB;AAG7B,MACG,YAAY,OAAO,aACpB,OAAO,4BACP,CAAC,uBAED;AAGF,QAAO,2BAA2B;AAGlC,gBAAe;CAEf,MAAM,SACJ,OAAO,QAAQ,2BAA2B;AAE5C,QAAO,QAAQ,oBAAoB;CAuCnC,MAAM,YAAY,UAAiB;AAGjC,MAAI,gBAAgB,CAAC,OAAO,kBAC1B;EAGF,IAAI,kBAAkB;AAEtB,MAAI,MAAM,WAAW,YAAY,MAAM,WAAW,OAChD,mBAAkB;OACb;GACL,MAAM,SAAU,MAAM,OAAmB,aACvC,6BACD;AAED,OAAI,OACF,mBAAkB,gCAAgC,OAAO;OAEzD,mBAAkB,eAAe,MAAM,OAAO;;EAIlD,MAAM,aAAa,OAAO,OAAO,OAAO,SAAS,MAAM;AAEvD,yBAAuB,KAAK,UAAU;GACpC,MAAM,WAAY,MAAM,gBAAgB,EAAE;GAE1C,MAAM,eAAgB,SAAS,qBAC7B,EAAE;AAEJ,OAAI,oBAAoB,UAAU;AAChC,iBAAa,UAAU,OAAO,WAAW;AACzC,iBAAa,UAAU,OAAO,WAAW;cAChC,iBAAiB;IAC1B,MAAM,UAAU,SAAS,cAAc,gBAAgB;AACvD,QAAI,SAAS;AACX,kBAAa,UAAU,QAAQ,cAAc;AAC7C,kBAAa,UAAU,QAAQ,aAAa;;;AAIhD,UAAO;IACP;;AAIJ,KAAI,OAAO,aAAa,YACtB,UAAS,iBAAiB,UAAU,SAAS,UAAU,IAAI,EAAE,KAAK;AAGpE,QAAO,UAAU,eAAe,UAAU;EAGxC,MAAM,WAAW,OAAO,MAAM,WAAW;AAIzC,MAAI,CAAC,OAAO,iBAAiB;AAC3B,UAAO,kBAAkB;AACzB;;AAEF,MAAI,OAAO,OAAO,QAAQ,sBAAsB;OAI1C,CAHkB,OAAO,QAAQ,kBAAkB,EACrD,UAAU,OAAO,gBAClB,CAAC,CAEA;;AAIJ,gBAAc;GACZ;GACA,KAAK;GACL,UAAU,OAAO,QAAQ;GACzB,yBAAyB,OAAO;GAChC,sBAAsB,OAAO,QAAQ;GACrC,UAAU,OAAO,QAAQ;GAC1B,CAAC;AAEF,MAAI,OAAO,kBAET,wBAAuB,KAAK,UAAU;AACpC,SAAM,cAAc,EAAE;AAEtB,UAAO;IACP;GAEJ;;;;;;;;;;;;;;;AAgBJ,SAAgB,iBAAiB,QAAmB;AAClD,KAAI,OAAO,aAAa,eAAgB,SAAiB,eAAe;EACtE,MAAM,WAAW,OAAO,OAAO,SAAS;EACxC,MAAM,4BACJ,SAAS,MAAM,+BAA+B;AAEhD,MAAI,6BAA6B,SAAS,SAAS,IAAI;GACrD,MAAM,KAAK,SAAS,eAAe,SAAS,KAAK;AACjD,OAAI,GACF,IAAG,eAAe,0BAA0B"}
+{"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.state ?? router.stores.location.state,\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    const fromIndex = event.fromLocation?.state.__TSR_index\n    const toIndex = event.toLocation.state.__TSR_index\n    // Clear on forward navigations, and on same-entry replace navigations where\n    // the href changed. Preserve back/restore entries so they can be restored.\n    const shouldClearCache =\n      typeof fromIndex === 'number' && typeof toIndex === 'number'\n        ? toIndex > fromIndex ||\n          (toIndex === fromIndex &&\n            event.fromLocation?.href !== event.toLocation.href)\n        : true\n\n    if (shouldClearCache) {\n      cache.set((state) => {\n        delete state[cacheKey]\n        return state\n      })\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,IAAa,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,IAAa,yBAAyB,8BAA8B;;;;;;;AAQpE,IAAa,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,IAAM,qBAAqB;AAC3B,IAAM,+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,SAAS,OAAO,OAAO,SAAS,MAChE,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;EAGF,MAAM,YAAY,MAAM,cAAc,MAAM;EAC5C,MAAM,UAAU,MAAM,WAAW,MAAM;AAUvC,MANE,OAAO,cAAc,YAAY,OAAO,YAAY,WAChD,UAAU,aACT,YAAY,aACX,MAAM,cAAc,SAAS,MAAM,WAAW,OAChD,KAGJ,OAAM,KAAK,UAAU;AACnB,UAAO,MAAM;AACb,UAAO;IACP;AAGJ,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"}

package/dist/esm/ssr/tsrScript.js

@@ -1,5 +1,5 @@
 //#region src/ssr/tsrScript.ts?script-string
-var tsrScript_default = "self.$_TSR={h(){this.hydrated=!0,this.c()},e(){this.streamEnded=!0,this.c()},c(){this.hydrated&&this.streamEnded&&(delete self.$_TSR,delete self.$R.tsr)},p(e){this.initialized?e():this.buffer.push(e)},buffer:[]};\n";
+var tsrScript_default = "self.$_TSR={h(){this.hydrated=!0,this.c()},e(){this.streamEnded=!0,this.c()},c(){this.hydrated&&this.streamEnded&&(delete self.$_TSR,delete self.$R.tsr)},p(e){this.initialized?e():this.buffer.push(e)},buffer:[]}";
 //#endregion
 export { tsrScript_default as default };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/router-core",
-  "version": "1.168.4",
+  "version": "1.168.5",
   "description": "Modern and scalable routing for React applications",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -133,6 +133,26 @@
         "default": "./dist/cjs/isServer/client.cjs"
       }
     },
+    "./scroll-restoration-script": {
+      "browser": {
+        "import": {
+          "types": "./dist/esm/scroll-restoration-script/client.d.ts",
+          "default": "./dist/esm/scroll-restoration-script/client.js"
+        },
+        "require": {
+          "types": "./dist/cjs/scroll-restoration-script/client.d.cts",
+          "default": "./dist/cjs/scroll-restoration-script/client.cjs"
+        }
+      },
+      "import": {
+        "types": "./dist/esm/scroll-restoration-script/server.d.ts",
+        "default": "./dist/esm/scroll-restoration-script/server.js"
+      },
+      "require": {
+        "types": "./dist/cjs/scroll-restoration-script/server.d.cts",
+        "default": "./dist/cjs/scroll-restoration-script/server.cjs"
+      }
+    },
     "./package.json": "./package.json"
   },
   "sideEffects": false,

package/src/hash-scroll.ts

@@ -0,0 +1,21 @@
+import type { AnyRouter } from './router'
+
+/**
+ * @private
+ * Handles hash-based scrolling after navigation completes.
+ * To be used in framework-specific <Transitioner> components during the onResolved event.
+ */
+export function handleHashScroll(router: AnyRouter) {
+  if (typeof document !== 'undefined' && (document as any).querySelector) {
+    const location = router.stores.location.state
+    const hashScrollIntoViewOptions =
+      location.state.__hashScrollIntoViewOptions ?? true
+
+    if (hashScrollIntoViewOptions && location.hash !== '') {
+      const el = document.getElementById(location.hash)
+      if (el) {
+        el.scrollIntoView(hashScrollIntoViewOptions)
+      }
+    }
+  }
+}

package/src/index.ts

@@ -397,14 +397,14 @@ export { isNotFound, notFound } from './not-found'
 
 export {
   defaultGetScrollRestorationKey,
-  restoreScroll,
+  getElementScrollRestorationEntry,
   storageKey,
-  getCssSelector,
   scrollRestorationCache,
   setupScrollRestoration,
-  handleHashScroll,
 } from './scroll-restoration'
 
+export { handleHashScroll } from './hash-scroll'
+
 export type {
   ScrollRestorationOptions,
   ScrollRestorationEntry,

package/src/scroll-restoration-inline.ts

@@ -0,0 +1,81 @@
+export default function (options: {
+  storageKey: string
+  key?: string
+  behavior?: ScrollToOptions['behavior']
+  shouldScrollRestoration?: boolean
+}) {
+  let byKey
+
+  try {
+    byKey = JSON.parse(sessionStorage.getItem(options.storageKey) || '{}')
+  } catch (error) {
+    console.error(error)
+    return
+  }
+
+  const resolvedKey = options.key || window.history.state?.__TSR_key
+  const elementEntries = resolvedKey ? byKey[resolvedKey] : undefined
+
+  if (
+    options.shouldScrollRestoration &&
+    elementEntries &&
+    typeof elementEntries === 'object' &&
+    Object.keys(elementEntries).length > 0
+  ) {
+    for (const elementSelector in elementEntries) {
+      const entry = elementEntries[elementSelector]
+
+      if (!entry || typeof entry !== 'object') {
+        continue
+      }
+
+      const scrollX = entry.scrollX
+      const scrollY = entry.scrollY
+
+      if (!Number.isFinite(scrollX) || !Number.isFinite(scrollY)) {
+        continue
+      }
+
+      if (elementSelector === 'window') {
+        window.scrollTo({
+          top: scrollY,
+          left: scrollX,
+          behavior: options.behavior,
+        })
+      } else if (elementSelector) {
+        let element
+
+        try {
+          element = document.querySelector(elementSelector)
+        } catch {
+          continue
+        }
+
+        if (element) {
+          element.scrollLeft = scrollX
+          element.scrollTop = scrollY
+        }
+      }
+    }
+
+    return
+  }
+
+  const hash = window.location.hash.split('#', 2)[1]
+
+  if (hash) {
+    const hashScrollIntoViewOptions =
+      window.history.state?.__hashScrollIntoViewOptions ?? true
+
+    if (hashScrollIntoViewOptions) {
+      const el = document.getElementById(hash)
+      if (el) {
+        el.scrollIntoView(hashScrollIntoViewOptions)
+      }
+    }
+
+    return
+  }
+
+  window.scrollTo({ top: 0, left: 0, behavior: options.behavior })
+}

package/src/scroll-restoration-script/client.ts

@@ -0,0 +1,5 @@
+import type { AnyRouter } from '../router'
+
+export function getScrollRestorationScriptForRouter(_router: AnyRouter) {
+  return null
+}

package/src/scroll-restoration-script/server.ts

@@ -0,0 +1,64 @@
+import minifiedScrollRestorationScript from '../scroll-restoration-inline?script-string'
+import {
+  defaultGetScrollRestorationKey,
+  storageKey,
+} from '../scroll-restoration'
+import { escapeHtml } from '../utils'
+import type { AnyRouter } from '../router'
+
+type InlineScrollRestorationScriptOptions = {
+  storageKey: string
+  key?: string
+  behavior?: ScrollToOptions['behavior']
+  shouldScrollRestoration?: boolean
+}
+
+const defaultInlineScrollRestorationScript = `(${minifiedScrollRestorationScript})(${escapeHtml(
+  JSON.stringify({
+    storageKey,
+    shouldScrollRestoration: true,
+  } satisfies InlineScrollRestorationScriptOptions),
+)})`
+
+function getScrollRestorationScript(
+  options: InlineScrollRestorationScriptOptions,
+) {
+  if (
+    options.storageKey === storageKey &&
+    options.shouldScrollRestoration === true &&
+    options.key === undefined &&
+    options.behavior === undefined
+  ) {
+    return defaultInlineScrollRestorationScript
+  }
+
+  return `(${minifiedScrollRestorationScript})(${escapeHtml(JSON.stringify(options))})`
+}
+
+export function getScrollRestorationScriptForRouter(router: AnyRouter) {
+  if (
+    typeof router.options.scrollRestoration === 'function' &&
+    !router.options.scrollRestoration({ location: router.latestLocation })
+  ) {
+    return null
+  }
+
+  const getKey = router.options.getScrollRestorationKey
+  if (!getKey) {
+    return defaultInlineScrollRestorationScript
+  }
+
+  const location = router.latestLocation
+  const userKey = getKey(location)
+  const defaultKey = defaultGetScrollRestorationKey(location)
+
+  if (userKey === defaultKey) {
+    return defaultInlineScrollRestorationScript
+  }
+
+  return getScrollRestorationScript({
+    storageKey,
+    shouldScrollRestoration: true,
+    key: userKey,
+  })
+}