@tanstack/router-core 1.168.4 → 1.168.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/dist/cjs/hash-scroll.cjs +20 -0
  2. package/dist/cjs/hash-scroll.cjs.map +1 -0
  3. package/dist/cjs/hash-scroll.d.cts +7 -0
  4. package/dist/cjs/index.cjs +3 -3
  5. package/dist/cjs/index.d.cts +2 -1
  6. package/dist/cjs/scroll-restoration-inline.cjs +6 -0
  7. package/dist/cjs/scroll-restoration-inline.cjs.map +1 -0
  8. package/dist/cjs/scroll-restoration-inline.d.cts +6 -0
  9. package/dist/cjs/scroll-restoration-script/client.cjs +9 -0
  10. package/dist/cjs/scroll-restoration-script/client.cjs.map +1 -0
  11. package/dist/cjs/scroll-restoration-script/client.d.cts +2 -0
  12. package/dist/cjs/scroll-restoration-script/server.cjs +30 -0
  13. package/dist/cjs/scroll-restoration-script/server.cjs.map +1 -0
  14. package/dist/cjs/scroll-restoration-script/server.d.cts +2 -0
  15. package/dist/cjs/scroll-restoration.cjs +124 -142
  16. package/dist/cjs/scroll-restoration.cjs.map +1 -1
  17. package/dist/cjs/scroll-restoration.d.cts +15 -38
  18. package/dist/cjs/ssr/tsrScript.cjs +1 -1
  19. package/dist/esm/hash-scroll.d.ts +7 -0
  20. package/dist/esm/hash-scroll.js +20 -0
  21. package/dist/esm/hash-scroll.js.map +1 -0
  22. package/dist/esm/index.d.ts +2 -1
  23. package/dist/esm/index.js +3 -2
  24. package/dist/esm/scroll-restoration-inline.d.ts +6 -0
  25. package/dist/esm/scroll-restoration-inline.js +6 -0
  26. package/dist/esm/scroll-restoration-inline.js.map +1 -0
  27. package/dist/esm/scroll-restoration-script/client.d.ts +2 -0
  28. package/dist/esm/scroll-restoration-script/client.js +8 -0
  29. package/dist/esm/scroll-restoration-script/client.js.map +1 -0
  30. package/dist/esm/scroll-restoration-script/server.d.ts +2 -0
  31. package/dist/esm/scroll-restoration-script/server.js +29 -0
  32. package/dist/esm/scroll-restoration-script/server.js.map +1 -0
  33. package/dist/esm/scroll-restoration.d.ts +15 -38
  34. package/dist/esm/scroll-restoration.js +125 -141
  35. package/dist/esm/scroll-restoration.js.map +1 -1
  36. package/dist/esm/ssr/tsrScript.js +1 -1
  37. package/package.json +21 -1
  38. package/src/hash-scroll.ts +21 -0
  39. package/src/index.ts +3 -3
  40. package/src/scroll-restoration-inline.ts +81 -0
  41. package/src/scroll-restoration-script/client.ts +5 -0
  42. package/src/scroll-restoration-script/server.ts +64 -0
  43. package/src/scroll-restoration.ts +226 -272
@@ -0,0 +1,20 @@
1
+ //#region src/hash-scroll.ts
2
+ /**
3
+ * @private
4
+ * Handles hash-based scrolling after navigation completes.
5
+ * To be used in framework-specific <Transitioner> components during the onResolved event.
6
+ */
7
+ function handleHashScroll(router) {
8
+ if (typeof document !== "undefined" && document.querySelector) {
9
+ const location = router.stores.location.state;
10
+ const hashScrollIntoViewOptions = location.state.__hashScrollIntoViewOptions ?? true;
11
+ if (hashScrollIntoViewOptions && location.hash !== "") {
12
+ const el = document.getElementById(location.hash);
13
+ if (el) el.scrollIntoView(hashScrollIntoViewOptions);
14
+ }
15
+ }
16
+ }
17
+ //#endregion
18
+ exports.handleHashScroll = handleHashScroll;
19
+
20
+ //# sourceMappingURL=hash-scroll.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"hash-scroll.cjs","names":[],"sources":["../../src/hash-scroll.ts"],"sourcesContent":["import type { AnyRouter } from './router'\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 */\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":";;;;;;AAOA,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"}
@@ -0,0 +1,7 @@
1
+ import { AnyRouter } from './router.cjs';
2
+ /**
3
+ * @private
4
+ * Handles hash-based scrolling after navigation completes.
5
+ * To be used in framework-specific <Transitioner> components during the onResolved event.
6
+ */
7
+ export declare function handleHashScroll(router: AnyRouter): void;
@@ -18,6 +18,7 @@ const require_Matches = require("./Matches.cjs");
18
18
  const require_route = require("./route.cjs");
19
19
  const require_config = require("./config.cjs");
20
20
  const require_searchMiddleware = require("./searchMiddleware.cjs");
21
+ const require_hash_scroll = require("./hash-scroll.cjs");
21
22
  const require_transformer = require("./ssr/serializer/transformer.cjs");
22
23
  const require_RawStream = require("./ssr/serializer/RawStream.cjs");
23
24
  const require_seroval_plugins = require("./ssr/serializer/seroval-plugins.cjs");
@@ -54,11 +55,11 @@ exports.exactPathTest = require_path.exactPathTest;
54
55
  exports.executeRewriteInput = require_rewrite.executeRewriteInput;
55
56
  exports.functionalUpdate = require_utils.functionalUpdate;
56
57
  exports.getAssetCrossOrigin = require_manifest.getAssetCrossOrigin;
57
- exports.getCssSelector = require_scroll_restoration.getCssSelector;
58
+ exports.getElementScrollRestorationEntry = require_scroll_restoration.getElementScrollRestorationEntry;
58
59
  exports.getInitialRouterState = require_router.getInitialRouterState;
59
60
  exports.getLocationChangeInfo = require_router.getLocationChangeInfo;
60
61
  exports.getMatchedRoutes = require_router.getMatchedRoutes;
61
- exports.handleHashScroll = require_scroll_restoration.handleHashScroll;
62
+ exports.handleHashScroll = require_hash_scroll.handleHashScroll;
62
63
  exports.interpolatePath = require_path.interpolatePath;
63
64
  exports.invariant = require_invariant.invariant;
64
65
  exports.isDangerousProtocol = require_utils.isDangerousProtocol;
@@ -82,7 +83,6 @@ exports.removeTrailingSlash = require_path.removeTrailingSlash;
82
83
  exports.replaceEqualDeep = require_utils.replaceEqualDeep;
83
84
  exports.resolveManifestAssetLink = require_manifest.resolveManifestAssetLink;
84
85
  exports.resolvePath = require_path.resolvePath;
85
- exports.restoreScroll = require_scroll_restoration.restoreScroll;
86
86
  exports.retainSearchParams = require_searchMiddleware.retainSearchParams;
87
87
  exports.rootRouteId = require_root.rootRouteId;
88
88
  exports.scrollRestorationCache = require_scroll_restoration.scrollRestorationCache;
@@ -40,7 +40,8 @@ export type { Redirect, RedirectOptions, RedirectOptionsRoute, RedirectFnRoute,
40
40
  export { redirect, isRedirect, isResolvedRedirect, parseRedirect, } from './redirect.cjs';
41
41
  export type { NotFoundError } from './not-found.cjs';
42
42
  export { isNotFound, notFound } from './not-found.cjs';
43
- export { defaultGetScrollRestorationKey, restoreScroll, storageKey, getCssSelector, scrollRestorationCache, setupScrollRestoration, handleHashScroll, } from './scroll-restoration.cjs';
43
+ export { defaultGetScrollRestorationKey, getElementScrollRestorationEntry, storageKey, scrollRestorationCache, setupScrollRestoration, } from './scroll-restoration.cjs';
44
+ export { handleHashScroll } from './hash-scroll.cjs';
44
45
  export type { ScrollRestorationOptions, ScrollRestorationEntry, } from './scroll-restoration.cjs';
45
46
  export type { ValidateFromPath, ValidateToPath, ValidateSearch, ValidateParams, InferFrom, InferTo, InferMaskTo, InferMaskFrom, ValidateNavigateOptions, ValidateNavigateOptionsArray, ValidateRedirectOptions, ValidateRedirectOptionsArray, ValidateId, InferStrict, InferShouldThrow, InferSelected, ValidateUseSearchResult, ValidateUseParamsResult, } from './typePrimitives.cjs';
46
47
  export type { AnySerializationAdapter, SerializationAdapter, ValidateSerializableInput, ValidateSerializableInputResult, SerializerExtensions, ValidateSerializable, RegisteredSerializableInput, SerializableExtensions, DefaultSerializable, Serializable, TSR_SERIALIZABLE, TsrSerializable, } from './ssr/serializer/transformer.cjs';
@@ -0,0 +1,6 @@
1
+ //#region src/scroll-restoration-inline.ts?script-string
2
+ 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})}";
3
+ //#endregion
4
+ exports.default = scroll_restoration_inline_default;
5
+
6
+ //# sourceMappingURL=scroll-restoration-inline.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"scroll-restoration-inline.cjs","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"}
@@ -0,0 +1,6 @@
1
+ export default function (options: {
2
+ storageKey: string;
3
+ key?: string;
4
+ behavior?: ScrollToOptions['behavior'];
5
+ shouldScrollRestoration?: boolean;
6
+ }): void;
@@ -0,0 +1,9 @@
1
+ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
2
+ //#region src/scroll-restoration-script/client.ts
3
+ function getScrollRestorationScriptForRouter(_router) {
4
+ return null;
5
+ }
6
+ //#endregion
7
+ exports.getScrollRestorationScriptForRouter = getScrollRestorationScriptForRouter;
8
+
9
+ //# sourceMappingURL=client.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.cjs","names":[],"sources":["../../../src/scroll-restoration-script/client.ts"],"sourcesContent":["import type { AnyRouter } from '../router'\n\nexport function getScrollRestorationScriptForRouter(_router: AnyRouter) {\n return null\n}\n"],"mappings":";;AAEA,SAAgB,oCAAoC,SAAoB;AACtE,QAAO"}
@@ -0,0 +1,2 @@
1
+ import { AnyRouter } from '../router.cjs';
2
+ export declare function getScrollRestorationScriptForRouter(_router: AnyRouter): null;
@@ -0,0 +1,30 @@
1
+ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
2
+ const require_utils = require("../utils.cjs");
3
+ const require_scroll_restoration = require("../scroll-restoration.cjs");
4
+ const require_scroll_restoration_inline = require("../scroll-restoration-inline.cjs");
5
+ //#region src/scroll-restoration-script/server.ts
6
+ var defaultInlineScrollRestorationScript = `(${require_scroll_restoration_inline.default})(${require_utils.escapeHtml(JSON.stringify({
7
+ storageKey: require_scroll_restoration.storageKey,
8
+ shouldScrollRestoration: true
9
+ }))})`;
10
+ function getScrollRestorationScript(options) {
11
+ if (options.storageKey === "tsr-scroll-restoration-v1_3" && options.shouldScrollRestoration === true && options.key === void 0 && options.behavior === void 0) return defaultInlineScrollRestorationScript;
12
+ return `(${require_scroll_restoration_inline.default})(${require_utils.escapeHtml(JSON.stringify(options))})`;
13
+ }
14
+ function getScrollRestorationScriptForRouter(router) {
15
+ if (typeof router.options.scrollRestoration === "function" && !router.options.scrollRestoration({ location: router.latestLocation })) return null;
16
+ const getKey = router.options.getScrollRestorationKey;
17
+ if (!getKey) return defaultInlineScrollRestorationScript;
18
+ const location = router.latestLocation;
19
+ const userKey = getKey(location);
20
+ if (userKey === require_scroll_restoration.defaultGetScrollRestorationKey(location)) return defaultInlineScrollRestorationScript;
21
+ return getScrollRestorationScript({
22
+ storageKey: require_scroll_restoration.storageKey,
23
+ shouldScrollRestoration: true,
24
+ key: userKey
25
+ });
26
+ }
27
+ //#endregion
28
+ exports.getScrollRestorationScriptForRouter = getScrollRestorationScriptForRouter;
29
+
30
+ //# sourceMappingURL=server.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"server.cjs","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,IAAM,uCAAuC,IAAI,kCAAA,QAAgC,IAAI,cAAA,WACnF,KAAK,UAAU;CACb,YAAA,2BAAA;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,kCAAA,QAAgC,IAAI,cAAA,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,2BAAA,+BAA+B,SAAS,CAGzD,QAAO;AAGT,QAAO,2BAA2B;EAChC,YAAA,2BAAA;EACA,yBAAyB;EACzB,KAAK;EACN,CAAC"}
@@ -0,0 +1,2 @@
1
+ import { AnyRouter } from '../router.cjs';
2
+ export declare function getScrollRestorationScriptForRouter(router: AnyRouter): string | null;
@@ -3,40 +3,37 @@ let _tanstack_router_core_isServer = require("@tanstack/router-core/isServer");
3
3
  //#region src/scroll-restoration.ts
4
4
  function getSafeSessionStorage() {
5
5
  try {
6
- if (typeof window !== "undefined" && typeof window.sessionStorage === "object") return window.sessionStorage;
7
- } catch {}
6
+ return typeof window !== "undefined" && typeof window.sessionStorage === "object" ? window.sessionStorage : void 0;
7
+ } catch {
8
+ return;
9
+ }
8
10
  }
9
- /** SessionStorage key used to persist scroll restoration state. */
10
- /** SessionStorage key used to store scroll positions across navigations. */
11
- /** SessionStorage key used to store scroll positions across navigations. */
12
11
  var storageKey = "tsr-scroll-restoration-v1_3";
13
- var throttle = (fn, wait) => {
14
- let timeout;
15
- return (...args) => {
16
- if (!timeout) timeout = setTimeout(() => {
17
- fn(...args);
18
- timeout = null;
19
- }, wait);
20
- };
21
- };
22
12
  function createScrollRestorationCache() {
23
13
  const safeSessionStorage = getSafeSessionStorage();
24
14
  if (!safeSessionStorage) return null;
25
- const persistedState = safeSessionStorage.getItem(storageKey);
26
- let state = persistedState ? JSON.parse(persistedState) : {};
15
+ let state = {};
16
+ try {
17
+ const parsed = JSON.parse(safeSessionStorage.getItem("tsr-scroll-restoration-v1_3") || "{}");
18
+ if (require_utils.isPlainObject(parsed)) state = parsed;
19
+ } catch {}
20
+ const persist = () => {
21
+ try {
22
+ safeSessionStorage.setItem(storageKey, JSON.stringify(state));
23
+ } catch {
24
+ if (process.env.NODE_ENV !== "production") console.warn("[ts-router] Could not persist scroll restoration state to sessionStorage.");
25
+ }
26
+ };
27
27
  return {
28
- state,
28
+ get state() {
29
+ return state;
30
+ },
29
31
  set: (updater) => {
30
32
  state = require_utils.functionalUpdate(updater, state) || state;
31
- try {
32
- safeSessionStorage.setItem(storageKey, JSON.stringify(state));
33
- } catch {
34
- console.warn("[ts-router] Could not persist scroll restoration state to sessionStorage.");
35
- }
36
- }
33
+ },
34
+ persist
37
35
  };
38
36
  }
39
- /** In-memory handle to the persisted scroll restoration cache. */
40
37
  var scrollRestorationCache = createScrollRestorationCache();
41
38
  /**
42
39
  * The default `getKey` function for `useScrollRestoration`.
@@ -44,13 +41,9 @@ var scrollRestorationCache = createScrollRestorationCache();
44
41
  *
45
42
  * The `location.href` is used as a fallback to support the use case where the location state is not available like the initial render.
46
43
  */
47
- /**
48
- * Default scroll restoration cache key: location state key or full href.
49
- */
50
44
  var defaultGetScrollRestorationKey = (location) => {
51
45
  return location.state.__TSR_key || location.href;
52
46
  };
53
- /** Best-effort nth-child CSS selector for a given element. */
54
47
  function getCssSelector(el) {
55
48
  const path = [];
56
49
  let parent;
@@ -60,148 +53,137 @@ function getCssSelector(el) {
60
53
  }
61
54
  return `${path.reverse().join(" > ")}`.toLowerCase();
62
55
  }
63
- var ignoreScroll = false;
64
- function restoreScroll({ storageKey, key, behavior, shouldScrollRestoration, scrollToTopSelectors, location }) {
65
- let byKey;
66
- try {
67
- byKey = JSON.parse(sessionStorage.getItem(storageKey) || "{}");
68
- } catch (error) {
69
- console.error(error);
70
- return;
71
- }
72
- const resolvedKey = key || window.history.state?.__TSR_key;
73
- const elementEntries = byKey[resolvedKey];
74
- ignoreScroll = true;
75
- scroll: {
76
- if (shouldScrollRestoration && elementEntries && Object.keys(elementEntries).length > 0) {
77
- for (const elementSelector in elementEntries) {
78
- const entry = elementEntries[elementSelector];
79
- if (elementSelector === "window") window.scrollTo({
80
- top: entry.scrollY,
81
- left: entry.scrollX,
82
- behavior
83
- });
84
- else if (elementSelector) {
85
- const element = document.querySelector(elementSelector);
86
- if (element) {
87
- element.scrollLeft = entry.scrollX;
88
- element.scrollTop = entry.scrollY;
89
- }
90
- }
91
- }
92
- break scroll;
93
- }
94
- const hash = (location ?? window.location).hash.split("#", 2)[1];
95
- if (hash) {
96
- const hashScrollIntoViewOptions = window.history.state?.__hashScrollIntoViewOptions ?? true;
97
- if (hashScrollIntoViewOptions) {
98
- const el = document.getElementById(hash);
99
- if (el) el.scrollIntoView(hashScrollIntoViewOptions);
100
- }
101
- break scroll;
102
- }
103
- const scrollOptions = {
104
- top: 0,
105
- left: 0,
106
- behavior
107
- };
108
- window.scrollTo(scrollOptions);
109
- if (scrollToTopSelectors) for (const selector of scrollToTopSelectors) {
110
- if (selector === "window") continue;
111
- const element = typeof selector === "function" ? selector() : document.querySelector(selector);
112
- if (element) element.scrollTo(scrollOptions);
113
- }
114
- }
115
- ignoreScroll = false;
56
+ function getElementScrollRestorationEntry(router, options) {
57
+ const restoreKey = (options.getKey || defaultGetScrollRestorationKey)(router.latestLocation);
58
+ if (options.id) return scrollRestorationCache?.state[restoreKey]?.[`[${scrollRestorationIdAttribute}="${options.id}"]`];
59
+ const element = options.getElement?.();
60
+ if (!element) return;
61
+ return scrollRestorationCache?.state[restoreKey]?.[element instanceof Window ? windowScrollTarget : getCssSelector(element)];
116
62
  }
117
- /** Setup global listeners and hooks to support scroll restoration. */
118
- /** Setup global listeners and hooks to support scroll restoration. */
63
+ var ignoreScroll = false;
64
+ var windowScrollTarget = "window";
65
+ var scrollRestorationIdAttribute = "data-scroll-restoration-id";
119
66
  function setupScrollRestoration(router, force) {
120
67
  if (!scrollRestorationCache && !(_tanstack_router_core_isServer.isServer ?? router.isServer)) return;
68
+ const cache = scrollRestorationCache;
121
69
  if (force ?? router.options.scrollRestoration ?? false) router.isScrollRestoring = true;
122
- if ((_tanstack_router_core_isServer.isServer ?? router.isServer) || router.isScrollRestorationSetup || !scrollRestorationCache) return;
70
+ if ((_tanstack_router_core_isServer.isServer ?? router.isServer) || router.isScrollRestorationSetup || !cache) return;
123
71
  router.isScrollRestorationSetup = true;
124
72
  ignoreScroll = false;
125
73
  const getKey = router.options.getScrollRestorationKey || defaultGetScrollRestorationKey;
74
+ const trackedScrollEntries = /* @__PURE__ */ new Map();
126
75
  window.history.scrollRestoration = "manual";
127
76
  const onScroll = (event) => {
128
77
  if (ignoreScroll || !router.isScrollRestoring) return;
129
- let elementSelector = "";
130
- if (event.target === document || event.target === window) elementSelector = "window";
78
+ if (event.target === document || event.target === window) trackedScrollEntries.set(windowScrollTarget, {
79
+ scrollX: window.scrollX || 0,
80
+ scrollY: window.scrollY || 0
81
+ });
131
82
  else {
132
- const attrId = event.target.getAttribute("data-scroll-restoration-id");
133
- if (attrId) elementSelector = `[data-scroll-restoration-id="${attrId}"]`;
134
- else elementSelector = getCssSelector(event.target);
83
+ const target = event.target;
84
+ trackedScrollEntries.set(target, {
85
+ scrollX: target.scrollLeft || 0,
86
+ scrollY: target.scrollTop || 0
87
+ });
135
88
  }
136
- const restoreKey = getKey(router.stores.location.state);
137
- scrollRestorationCache.set((state) => {
138
- const keyEntry = state[restoreKey] ||= {};
139
- const elementEntry = keyEntry[elementSelector] ||= {};
140
- if (elementSelector === "window") {
141
- elementEntry.scrollX = window.scrollX || 0;
142
- elementEntry.scrollY = window.scrollY || 0;
143
- } else if (elementSelector) {
144
- const element = document.querySelector(elementSelector);
145
- if (element) {
146
- elementEntry.scrollX = element.scrollLeft || 0;
147
- elementEntry.scrollY = element.scrollTop || 0;
148
- }
89
+ };
90
+ const snapshotCurrentScrollTargets = (restoreKey) => {
91
+ if (!router.isScrollRestoring || !restoreKey || trackedScrollEntries.size === 0 || !cache) return;
92
+ const keyEntry = cache.state[restoreKey] ||= {};
93
+ for (const [target, position] of trackedScrollEntries) {
94
+ let selector;
95
+ if (target === windowScrollTarget) selector = windowScrollTarget;
96
+ else if (target.isConnected) {
97
+ const attrId = target.getAttribute(scrollRestorationIdAttribute);
98
+ selector = attrId ? `[${scrollRestorationIdAttribute}="${attrId}"]` : getCssSelector(target);
149
99
  }
150
- return state;
151
- });
100
+ if (!selector) continue;
101
+ keyEntry[selector] = position;
102
+ }
152
103
  };
153
- if (typeof document !== "undefined") document.addEventListener("scroll", throttle(onScroll, 100), true);
104
+ document.addEventListener("scroll", onScroll, true);
105
+ router.subscribe("onBeforeLoad", (event) => {
106
+ snapshotCurrentScrollTargets(event.fromLocation ? getKey(event.fromLocation) : void 0);
107
+ trackedScrollEntries.clear();
108
+ });
109
+ window.addEventListener("pagehide", () => {
110
+ snapshotCurrentScrollTargets(getKey(router.stores.resolvedLocation.state ?? router.stores.location.state));
111
+ cache.persist();
112
+ });
154
113
  router.subscribe("onRendered", (event) => {
155
114
  const cacheKey = getKey(event.toLocation);
115
+ const behavior = router.options.scrollRestorationBehavior;
116
+ const scrollToTopSelectors = router.options.scrollToTopSelectors;
117
+ trackedScrollEntries.clear();
156
118
  if (!router.resetNextScroll) {
157
119
  router.resetNextScroll = true;
158
120
  return;
159
121
  }
160
- if (typeof router.options.scrollRestoration === "function") {
161
- if (!router.options.scrollRestoration({ location: router.latestLocation })) return;
122
+ if (typeof router.options.scrollRestoration === "function" && !router.options.scrollRestoration({ location: router.latestLocation })) return;
123
+ ignoreScroll = true;
124
+ try {
125
+ const elementEntries = router.isScrollRestoring ? cache.state[cacheKey] : void 0;
126
+ let restored = false;
127
+ if (elementEntries) for (const elementSelector in elementEntries) {
128
+ const entry = elementEntries[elementSelector];
129
+ if (!require_utils.isPlainObject(entry)) continue;
130
+ const { scrollX, scrollY } = entry;
131
+ if (!Number.isFinite(scrollX) || !Number.isFinite(scrollY)) continue;
132
+ if (elementSelector === windowScrollTarget) {
133
+ window.scrollTo({
134
+ top: scrollY,
135
+ left: scrollX,
136
+ behavior
137
+ });
138
+ restored = true;
139
+ } else if (elementSelector) {
140
+ let element;
141
+ try {
142
+ element = document.querySelector(elementSelector);
143
+ } catch {
144
+ continue;
145
+ }
146
+ if (element) {
147
+ element.scrollLeft = scrollX;
148
+ element.scrollTop = scrollY;
149
+ restored = true;
150
+ }
151
+ }
152
+ }
153
+ if (!restored) {
154
+ const hash = router.history.location.hash.slice(1);
155
+ if (hash) {
156
+ const hashScrollIntoViewOptions = window.history.state?.__hashScrollIntoViewOptions ?? true;
157
+ if (hashScrollIntoViewOptions) {
158
+ const el = document.getElementById(hash);
159
+ if (el) el.scrollIntoView(hashScrollIntoViewOptions);
160
+ }
161
+ } else {
162
+ const scrollOptions = {
163
+ top: 0,
164
+ left: 0,
165
+ behavior
166
+ };
167
+ window.scrollTo(scrollOptions);
168
+ if (scrollToTopSelectors) for (const selector of scrollToTopSelectors) {
169
+ if (selector === windowScrollTarget) continue;
170
+ const element = typeof selector === "function" ? selector() : document.querySelector(selector);
171
+ if (element) element.scrollTo(scrollOptions);
172
+ }
173
+ }
174
+ }
175
+ } finally {
176
+ ignoreScroll = false;
162
177
  }
163
- restoreScroll({
164
- storageKey,
165
- key: cacheKey,
166
- behavior: router.options.scrollRestorationBehavior,
167
- shouldScrollRestoration: router.isScrollRestoring,
168
- scrollToTopSelectors: router.options.scrollToTopSelectors,
169
- location: router.history.location
170
- });
171
- if (router.isScrollRestoring) scrollRestorationCache.set((state) => {
178
+ if (router.isScrollRestoring) cache.set((state) => {
172
179
  state[cacheKey] ||= {};
173
180
  return state;
174
181
  });
175
182
  });
176
183
  }
177
- /**
178
- * @private
179
- * Handles hash-based scrolling after navigation completes.
180
- * To be used in framework-specific <Transitioner> components during the onResolved event.
181
- *
182
- * Provides hash scrolling for programmatic navigation when default browser handling is prevented.
183
- * @param router The router instance containing current location and state
184
- */
185
- /**
186
- * @private
187
- * Handles hash-based scrolling after navigation completes.
188
- * To be used in framework-specific Transitioners.
189
- */
190
- function handleHashScroll(router) {
191
- if (typeof document !== "undefined" && document.querySelector) {
192
- const location = router.stores.location.state;
193
- const hashScrollIntoViewOptions = location.state.__hashScrollIntoViewOptions ?? true;
194
- if (hashScrollIntoViewOptions && location.hash !== "") {
195
- const el = document.getElementById(location.hash);
196
- if (el) el.scrollIntoView(hashScrollIntoViewOptions);
197
- }
198
- }
199
- }
200
184
  //#endregion
201
185
  exports.defaultGetScrollRestorationKey = defaultGetScrollRestorationKey;
202
- exports.getCssSelector = getCssSelector;
203
- exports.handleHashScroll = handleHashScroll;
204
- exports.restoreScroll = restoreScroll;
186
+ exports.getElementScrollRestorationEntry = getElementScrollRestorationEntry;
205
187
  exports.scrollRestorationCache = scrollRestorationCache;
206
188
  exports.setupScrollRestoration = setupScrollRestoration;
207
189
  exports.storageKey = storageKey;
@@ -1 +1 @@
1
- {"version":3,"file":"scroll-restoration.cjs","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,cAAA,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,+BAAA,YAAY,OAAO,UAClD;AAKF,KAFE,SAAS,OAAO,QAAQ,qBAAqB,MAG7C,QAAO,oBAAoB;AAG7B,MACG,+BAAA,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"}
1
+ {"version":3,"file":"scroll-restoration.cjs","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 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,cAAA,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,cAAA,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,+BAAA,YAAY,OAAO,UAClD;CAGF,MAAM,QAAQ;AAKd,KAFE,SAAS,OAAO,QAAQ,qBAAqB,MAG7C,QAAO,oBAAoB;AAG7B,MACG,+BAAA,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;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,cAAA,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"}