@tanstack/router-core 1.171.3 → 1.171.5

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 (46) hide show
  1. package/dist/cjs/index.cjs +0 -3
  2. package/dist/cjs/index.d.cts +1 -2
  3. package/dist/cjs/rewrite.cjs +1 -6
  4. package/dist/cjs/rewrite.cjs.map +1 -1
  5. package/dist/cjs/rewrite.d.cts +0 -4
  6. package/dist/cjs/router.cjs +9 -2
  7. package/dist/cjs/router.cjs.map +1 -1
  8. package/dist/cjs/router.d.cts +5 -1
  9. package/dist/cjs/scroll-restoration-inline.cjs +1 -1
  10. package/dist/cjs/scroll-restoration-inline.cjs.map +1 -1
  11. package/dist/cjs/scroll-restoration-inline.d.cts +1 -6
  12. package/dist/cjs/scroll-restoration-script/server.cjs +5 -12
  13. package/dist/cjs/scroll-restoration-script/server.cjs.map +1 -1
  14. package/dist/cjs/scroll-restoration.cjs +117 -111
  15. package/dist/cjs/scroll-restoration.cjs.map +1 -1
  16. package/dist/cjs/scroll-restoration.d.cts +0 -10
  17. package/dist/esm/index.d.ts +1 -2
  18. package/dist/esm/index.js +2 -3
  19. package/dist/esm/rewrite.d.ts +0 -4
  20. package/dist/esm/rewrite.js +1 -6
  21. package/dist/esm/rewrite.js.map +1 -1
  22. package/dist/esm/router.d.ts +5 -1
  23. package/dist/esm/router.js +9 -3
  24. package/dist/esm/router.js.map +1 -1
  25. package/dist/esm/scroll-restoration-inline.d.ts +1 -6
  26. package/dist/esm/scroll-restoration-inline.js +1 -1
  27. package/dist/esm/scroll-restoration-inline.js.map +1 -1
  28. package/dist/esm/scroll-restoration-script/server.js +5 -12
  29. package/dist/esm/scroll-restoration-script/server.js.map +1 -1
  30. package/dist/esm/scroll-restoration.d.ts +0 -10
  31. package/dist/esm/scroll-restoration.js +118 -111
  32. package/dist/esm/scroll-restoration.js.map +1 -1
  33. package/package.json +1 -1
  34. package/src/index.ts +0 -3
  35. package/src/rewrite.ts +1 -8
  36. package/src/router.ts +28 -4
  37. package/src/scroll-restoration-inline.ts +23 -51
  38. package/src/scroll-restoration-script/server.ts +5 -26
  39. package/src/scroll-restoration.ts +190 -174
  40. package/dist/cjs/hash-scroll.cjs +0 -20
  41. package/dist/cjs/hash-scroll.cjs.map +0 -1
  42. package/dist/cjs/hash-scroll.d.cts +0 -7
  43. package/dist/esm/hash-scroll.d.ts +0 -7
  44. package/dist/esm/hash-scroll.js +0 -20
  45. package/dist/esm/hash-scroll.js.map +0 -1
  46. package/src/hash-scroll.ts +0 -21
@@ -3,7 +3,7 @@ import { LRUCache } from './lru-cache.cjs';
3
3
  import { ProcessRouteTreeResult, ProcessedTree } from './new-process-route-tree.cjs';
4
4
  import { SearchParser, SearchSerializer } from './searchParams.cjs';
5
5
  import { AnyRedirect, ResolvedRedirect } from './redirect.cjs';
6
- import { HistoryLocation, HistoryState, ParsedHistoryState, RouterHistory } from '@tanstack/history';
6
+ import { HistoryAction, HistoryLocation, HistoryState, ParsedHistoryState, RouterHistory } from '@tanstack/history';
7
7
  import { Awaitable, Constrain, ControlledPromise, NoInfer, NonNullableUpdater, PickAsRequired, Updater } from './utils.cjs';
8
8
  import { ParsedLocation } from './location.cjs';
9
9
  import { AnyContext, AnyRoute, AnyRouteWithContext, LoaderStaleReloadMode, MakeRemountDepsOptionsUnion, RouteLike, RouteMask } from './route.cjs';
@@ -483,6 +483,9 @@ export type GetMatchRoutesFn = (pathname: string) => {
483
483
  export type EmitFn = (routerEvent: RouterEvent) => void;
484
484
  export type LoadFn = (opts?: {
485
485
  sync?: boolean;
486
+ action?: {
487
+ type: HistoryAction;
488
+ };
486
489
  }) => Promise<void>;
487
490
  export type CommitLocationFn = ({ viewTransition, ignoreBlocker, ...next }: ParsedLocation & CommitLocationOptions) => Promise<void>;
488
491
  export type StartTransitionFn = (fn: () => void) => void;
@@ -568,6 +571,7 @@ export declare function getLocationChangeInfo(location: ParsedLocation, resolved
568
571
  hrefChanged: boolean;
569
572
  hashChanged: boolean;
570
573
  };
574
+ export declare const locationHistoryActions: WeakMap<ParsedLocation<{}>, HistoryAction>;
571
575
  export type CreateRouterFn = <TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption = 'never', TDefaultStructuralSharingOption extends boolean = false, TRouterHistory extends RouterHistory = RouterHistory, TDehydrated extends Record<string, any> = Record<string, any>>(options: undefined extends number ? 'strictNullChecks must be enabled in tsconfig.json' : RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>) => RouterCore<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>;
572
576
  declare global {
573
577
  var __TSR_CACHE__: {
@@ -1,5 +1,5 @@
1
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})}";
2
+ var scroll_restoration_inline_default = "function(a,f){let l;try{l=JSON.parse(sessionStorage.getItem(a)||\"{}\")}catch{return}const n=l?.[f||history.state?.__TSR_key];let c=!1;for(const t in n){const e=n[t],o=e?.scrollX,s=e?.scrollY;if(Number.isFinite(o)&&Number.isFinite(s)){if(t===\"window\")scrollTo(o,s),c=!0;else if(t)try{const r=document.querySelector(t);r&&(r.scrollLeft=o,r.scrollTop=s)}catch{}}}if(c)return;const i=location.hash.slice(1);if(i){const t=history.state?.__hashScrollIntoViewOptions??!0;if(t){const e=document.getElementById(i);e&&e.scrollIntoView(t)}return}scrollTo(0,0)}";
3
3
  //#endregion
4
4
  exports.default = scroll_restoration_inline_default;
5
5
 
@@ -1 +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"}
1
+ {"version":3,"file":"scroll-restoration-inline.cjs","names":[],"sources":["../../src/scroll-restoration-inline.ts?script-string"],"sourcesContent":["export default function (storageKey: string, key?: string) {\n let byKey\n\n try {\n byKey = JSON.parse(sessionStorage.getItem(storageKey) || '{}')\n } catch {\n return\n }\n\n const elementEntries = byKey?.[key || history.state?.__TSR_key]\n let windowRestored = false\n\n for (const elementSelector in elementEntries) {\n const entry = elementEntries[elementSelector]\n const scrollX = entry?.scrollX\n const scrollY = entry?.scrollY\n\n if (Number.isFinite(scrollX) && Number.isFinite(scrollY)) {\n if (elementSelector === 'window') {\n scrollTo(scrollX, scrollY)\n windowRestored = true\n } else if (elementSelector) {\n try {\n const element = document.querySelector(elementSelector)\n if (element) {\n element.scrollLeft = scrollX\n element.scrollTop = scrollY\n }\n } catch {}\n }\n }\n }\n\n if (windowRestored) return\n\n const hash = location.hash.slice(1)\n\n if (hash) {\n const hashScrollIntoViewOptions =\n history.state?.__hashScrollIntoViewOptions ?? true\n\n if (hashScrollIntoViewOptions) {\n const el = document.getElementById(hash)\n if (el) {\n el.scrollIntoView(hashScrollIntoViewOptions)\n }\n }\n\n return\n }\n\n scrollTo(0, 0)\n}\n"],"mappings":";AAAA,IAAA,oCAAe"}
@@ -1,6 +1 @@
1
- export default function (options: {
2
- storageKey: string;
3
- key?: string;
4
- behavior?: ScrollToOptions['behavior'];
5
- shouldScrollRestoration?: boolean;
6
- }): void;
1
+ export default function (storageKey: string, key?: string): void;
@@ -3,13 +3,10 @@ const require_utils = require("../utils.cjs");
3
3
  const require_scroll_restoration = require("../scroll-restoration.cjs");
4
4
  const require_scroll_restoration_inline = require("../scroll-restoration-inline.cjs");
5
5
  //#region src/scroll-restoration-script/server.ts
6
- const 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))})`;
6
+ const defaultInlineScrollRestorationScript = `(${require_scroll_restoration_inline.default})(${require_utils.escapeHtml(JSON.stringify(require_scroll_restoration.storageKey))})`;
7
+ function getScrollRestorationScript(key) {
8
+ if (key === void 0) return defaultInlineScrollRestorationScript;
9
+ return `(${require_scroll_restoration_inline.default})(${require_utils.escapeHtml(JSON.stringify(require_scroll_restoration.storageKey))},${require_utils.escapeHtml(JSON.stringify(key))})`;
13
10
  }
14
11
  function getScrollRestorationScriptForRouter(router) {
15
12
  if (typeof router.options.scrollRestoration === "function" && !router.options.scrollRestoration({ location: router.latestLocation })) return null;
@@ -18,11 +15,7 @@ function getScrollRestorationScriptForRouter(router) {
18
15
  const location = router.latestLocation;
19
16
  const userKey = getKey(location);
20
17
  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
- });
18
+ return getScrollRestorationScript(userKey);
26
19
  }
27
20
  //#endregion
28
21
  exports.getScrollRestorationScriptForRouter = getScrollRestorationScriptForRouter;
@@ -1 +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,MAAM,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"}
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\nconst defaultInlineScrollRestorationScript = `(${minifiedScrollRestorationScript})(${escapeHtml(\n JSON.stringify(storageKey),\n)})`\n\nfunction getScrollRestorationScript(key?: string) {\n if (key === undefined) {\n return defaultInlineScrollRestorationScript\n }\n\n return `(${minifiedScrollRestorationScript})(${escapeHtml(JSON.stringify(storageKey))},${escapeHtml(JSON.stringify(key))})`\n}\n\nexport function getScrollRestorationScriptForRouter(router: AnyRouter) {\n if (\n typeof router.options.scrollRestoration === 'function' &&\n !router.options.scrollRestoration({ location: router.latestLocation })\n ) {\n return null\n }\n\n const getKey = router.options.getScrollRestorationKey\n if (!getKey) {\n return defaultInlineScrollRestorationScript\n }\n\n const location = router.latestLocation\n const userKey = getKey(location)\n const defaultKey = defaultGetScrollRestorationKey(location)\n\n if (userKey === defaultKey) {\n return defaultInlineScrollRestorationScript\n }\n\n return getScrollRestorationScript(userKey)\n}\n"],"mappings":";;;;;AAQA,MAAM,uCAAuC,IAAI,kCAAA,QAAgC,IAAI,cAAA,WACnF,KAAK,UAAU,2BAAA,WAAW,CAC3B,CAAC;AAEF,SAAS,2BAA2B,KAAc;AAChD,KAAI,QAAQ,KAAA,EACV,QAAO;AAGT,QAAO,IAAI,kCAAA,QAAgC,IAAI,cAAA,WAAW,KAAK,UAAU,2BAAA,WAAW,CAAC,CAAC,GAAG,cAAA,WAAW,KAAK,UAAU,IAAI,CAAC,CAAC;;AAG3H,SAAgB,oCAAoC,QAAmB;AACrE,KACE,OAAO,OAAO,QAAQ,sBAAsB,cAC5C,CAAC,OAAO,QAAQ,kBAAkB,EAAE,UAAU,OAAO,gBAAgB,CAAC,CAEtE,QAAO;CAGT,MAAM,SAAS,OAAO,QAAQ;AAC9B,KAAI,CAAC,OACH,QAAO;CAGT,MAAM,WAAW,OAAO;CACxB,MAAM,UAAU,OAAO,SAAS;AAGhC,KAAI,YAFe,2BAAA,+BAA+B,SAAS,CAGzD,QAAO;AAGT,QAAO,2BAA2B,QAAQ"}
@@ -1,40 +1,31 @@
1
- const require_utils = require("./utils.cjs");
1
+ const require_router = require("./router.cjs");
2
2
  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
- return typeof window !== "undefined" && typeof window.sessionStorage === "object" ? window.sessionStorage : void 0;
6
+ return sessionStorage;
7
7
  } catch {
8
8
  return;
9
9
  }
10
10
  }
11
11
  const storageKey = "tsr-scroll-restoration-v1_3";
12
+ const safeSessionStorage = getSafeSessionStorage();
12
13
  function createScrollRestorationCache() {
13
- const safeSessionStorage = getSafeSessionStorage();
14
- if (!safeSessionStorage) return null;
15
- let state = {};
16
14
  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
- return {
28
- get state() {
29
- return state;
30
- },
31
- set: (updater) => {
32
- state = require_utils.functionalUpdate(updater, state) || state;
33
- },
34
- persist
35
- };
15
+ return JSON.parse(safeSessionStorage?.getItem("tsr-scroll-restoration-v1_3") || "{}");
16
+ } catch {
17
+ return {};
18
+ }
19
+ }
20
+ function persistScrollRestorationCache() {
21
+ try {
22
+ safeSessionStorage?.setItem(storageKey, JSON.stringify(scrollRestorationCache));
23
+ } catch {
24
+ if (process.env.NODE_ENV !== "production") console.warn("[ts-router] Could not persist scroll restoration state to sessionStorage.");
25
+ }
36
26
  }
37
- const scrollRestorationCache = createScrollRestorationCache();
27
+ const scrollRestorationCache = /* @__PURE__ */ createScrollRestorationCache();
28
+ const scrollRestorationIdAttribute = "data-scroll-restoration-id";
38
29
  /**
39
30
  * The default `getKey` function for `useScrollRestoration`.
40
31
  * It returns the `key` from the location state or the `href` of the location.
@@ -44,147 +35,162 @@ const scrollRestorationCache = createScrollRestorationCache();
44
35
  const defaultGetScrollRestorationKey = (location) => {
45
36
  return location.state.__TSR_key || location.href;
46
37
  };
47
- function getCssSelector(el) {
48
- const path = [];
38
+ function getScrollRestorationSelector(element) {
39
+ const attrId = element.getAttribute(scrollRestorationIdAttribute);
40
+ if (attrId) return `[${scrollRestorationIdAttribute}="${attrId}"]`;
41
+ let selector = "";
42
+ let el = element;
49
43
  let parent;
50
44
  while (parent = el.parentNode) {
51
- path.push(`${el.tagName}:nth-child(${Array.prototype.indexOf.call(parent.children, el) + 1})`);
45
+ let index = 1;
46
+ let sibling = el;
47
+ while (sibling = sibling.previousElementSibling) index++;
48
+ const part = `${el.localName}:nth-child(${index})`;
49
+ selector = selector ? `${part} > ${selector}` : part;
52
50
  el = parent;
53
51
  }
54
- return `${path.reverse().join(" > ")}`.toLowerCase();
52
+ return selector;
55
53
  }
56
54
  function getElementScrollRestorationEntry(router, options) {
57
- const restoreKey = (options.getKey || defaultGetScrollRestorationKey)(router.latestLocation);
58
- if (options.id) return scrollRestorationCache?.state[restoreKey]?.[`[${scrollRestorationIdAttribute}="${options.id}"]`];
55
+ const entries = scrollRestorationCache[(options.getKey || defaultGetScrollRestorationKey)(router.latestLocation)];
56
+ if (!entries) return;
57
+ if (options.id) return entries[`[${scrollRestorationIdAttribute}="${options.id}"]`];
59
58
  const element = options.getElement?.();
60
59
  if (!element) return;
61
- return scrollRestorationCache?.state[restoreKey]?.[element instanceof Window ? windowScrollTarget : getCssSelector(element)];
60
+ return entries[element === window ? windowScrollTarget : getScrollRestorationSelector(element)];
62
61
  }
63
62
  let ignoreScroll = false;
64
63
  const windowScrollTarget = "window";
65
- const scrollRestorationIdAttribute = "data-scroll-restoration-id";
64
+ function getElement(selector) {
65
+ try {
66
+ return typeof selector === "function" ? selector() : document.querySelector(selector);
67
+ } catch {}
68
+ }
69
+ function getScrollToTopElements(scrollToTopSelectors) {
70
+ const elements = [];
71
+ for (const selector of scrollToTopSelectors) {
72
+ if (selector === windowScrollTarget) continue;
73
+ const element = getElement(selector);
74
+ if (element) elements.push(element);
75
+ }
76
+ return elements;
77
+ }
66
78
  function setupScrollRestoration(router, force) {
67
- if (!scrollRestorationCache && !(_tanstack_router_core_isServer.isServer ?? router.isServer)) return;
68
- const cache = scrollRestorationCache;
69
- if (force ?? router.options.scrollRestoration ?? false) router.isScrollRestoring = true;
70
- if ((_tanstack_router_core_isServer.isServer ?? router.isServer) || router.isScrollRestorationSetup || !cache) return;
79
+ if (force ?? router.options.scrollRestoration) router.isScrollRestoring = true;
80
+ if ((_tanstack_router_core_isServer.isServer ?? router.isServer) || router.isScrollRestorationSetup) return;
71
81
  router.isScrollRestorationSetup = true;
72
82
  ignoreScroll = false;
73
83
  const getKey = router.options.getScrollRestorationKey || defaultGetScrollRestorationKey;
74
84
  const trackedScrollEntries = /* @__PURE__ */ new Map();
75
- window.history.scrollRestoration = "manual";
85
+ const setTrackedScrollEntry = (target, scrollX, scrollY) => {
86
+ const entry = trackedScrollEntries.get(target) || {};
87
+ entry.scrollX = scrollX;
88
+ entry.scrollY = scrollY;
89
+ trackedScrollEntries.set(target, entry);
90
+ };
91
+ history.scrollRestoration = "manual";
76
92
  const onScroll = (event) => {
77
93
  if (ignoreScroll || !router.isScrollRestoring) return;
78
- if (event.target === document || event.target === window) trackedScrollEntries.set(windowScrollTarget, {
79
- scrollX: window.scrollX || 0,
80
- scrollY: window.scrollY || 0
81
- });
94
+ if (event.target === document) setTrackedScrollEntry(windowScrollTarget, scrollX, scrollY);
82
95
  else {
83
96
  const target = event.target;
84
- trackedScrollEntries.set(target, {
85
- scrollX: target.scrollLeft || 0,
86
- scrollY: target.scrollTop || 0
87
- });
97
+ setTrackedScrollEntry(target, target.scrollLeft, target.scrollTop);
88
98
  }
89
99
  };
90
100
  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);
99
- }
100
- if (!selector) continue;
101
- keyEntry[selector] = position;
102
- }
101
+ if (!router.isScrollRestoring) return;
102
+ const keyEntry = scrollRestorationCache[restoreKey] ||= {};
103
+ for (const [target, position] of trackedScrollEntries) if (target === windowScrollTarget) keyEntry[windowScrollTarget] = position;
104
+ else if (target.isConnected) keyEntry[getScrollRestorationSelector(target)] = position;
103
105
  };
104
106
  document.addEventListener("scroll", onScroll, true);
105
107
  router.subscribe("onBeforeLoad", (event) => {
106
- snapshotCurrentScrollTargets(event.fromLocation ? getKey(event.fromLocation) : void 0);
108
+ if (event.fromLocation) snapshotCurrentScrollTargets(getKey(event.fromLocation));
107
109
  trackedScrollEntries.clear();
108
110
  });
109
- window.addEventListener("pagehide", () => {
111
+ addEventListener("pagehide", () => {
110
112
  snapshotCurrentScrollTargets(getKey(router.stores.resolvedLocation.get() ?? router.stores.location.get()));
111
- cache.persist();
113
+ persistScrollRestorationCache();
112
114
  });
113
115
  router.subscribe("onRendered", (event) => {
114
- const cacheKey = getKey(event.toLocation);
115
116
  const behavior = router.options.scrollRestorationBehavior;
116
117
  const scrollToTopSelectors = router.options.scrollToTopSelectors;
118
+ const shouldResetScroll = router.resetNextScroll;
119
+ let scrollToTopElements;
117
120
  trackedScrollEntries.clear();
118
- if (!router.resetNextScroll) {
119
- router.resetNextScroll = true;
120
- return;
121
- }
121
+ if (!shouldResetScroll) router.resetNextScroll = true;
122
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;
123
+ const cacheKey = getKey(event.toLocation);
124
+ const fromCacheKey = event.fromLocation && getKey(event.fromLocation);
125
+ if (router.isScrollRestoring && fromCacheKey && fromCacheKey !== cacheKey) {
126
+ const fromElementEntries = scrollRestorationCache[fromCacheKey];
127
+ if (fromElementEntries) {
128
+ let toElementEntries = scrollRestorationCache[cacheKey];
129
+ for (const elementSelector in fromElementEntries) {
130
+ if (elementSelector === windowScrollTarget) {
131
+ if (shouldResetScroll) continue;
132
+ } else {
133
+ const element = getElement(elementSelector);
134
+ if (!element) continue;
135
+ if (shouldResetScroll && scrollToTopSelectors) {
136
+ scrollToTopElements ??= getScrollToTopElements(scrollToTopSelectors);
137
+ if (scrollToTopElements.includes(element)) continue;
138
+ }
150
139
  }
140
+ if (!toElementEntries) toElementEntries = scrollRestorationCache[cacheKey] = {};
141
+ toElementEntries[elementSelector] ??= fromElementEntries[elementSelector];
151
142
  }
152
143
  }
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);
144
+ }
145
+ ignoreScroll = true;
146
+ try {
147
+ const hash = event.toLocation.hash;
148
+ const hashScrollIntoViewOptions = event.toLocation.state.__hashScrollIntoViewOptions ?? true;
149
+ let windowRestored = false;
150
+ if (shouldResetScroll) {
151
+ const action = require_router.locationHistoryActions.get(event.toLocation);
152
+ const skipWindowRestore = hash && hashScrollIntoViewOptions && (action === "PUSH" || action === "REPLACE");
153
+ const elementEntries = router.isScrollRestoring ? scrollRestorationCache[cacheKey] : void 0;
154
+ if (elementEntries) for (const elementSelector in elementEntries) {
155
+ const { scrollX, scrollY } = elementEntries[elementSelector];
156
+ if (elementSelector === windowScrollTarget) {
157
+ if (skipWindowRestore) continue;
158
+ scrollTo({
159
+ top: scrollY,
160
+ left: scrollX,
161
+ behavior
162
+ });
163
+ windowRestored = true;
164
+ } else {
165
+ const element = getElement(elementSelector);
166
+ if (element) {
167
+ element.scrollLeft = scrollX;
168
+ element.scrollTop = scrollY;
169
+ }
160
170
  }
161
- } else {
171
+ }
172
+ if (!windowRestored && !hash) {
162
173
  const scrollOptions = {
163
174
  top: 0,
164
175
  left: 0,
165
176
  behavior
166
177
  };
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);
178
+ scrollTo(scrollOptions);
179
+ if (scrollToTopSelectors) {
180
+ scrollToTopElements ??= getScrollToTopElements(scrollToTopSelectors);
181
+ for (const element of scrollToTopElements) element.scrollTo(scrollOptions);
172
182
  }
173
183
  }
174
184
  }
185
+ if (!windowRestored && hash && hashScrollIntoViewOptions) document.getElementById(hash)?.scrollIntoView(hashScrollIntoViewOptions);
175
186
  } finally {
176
187
  ignoreScroll = false;
177
188
  }
178
- if (router.isScrollRestoring) cache.set((state) => {
179
- state[cacheKey] ||= {};
180
- return state;
181
- });
182
189
  });
183
190
  }
184
191
  //#endregion
185
192
  exports.defaultGetScrollRestorationKey = defaultGetScrollRestorationKey;
186
193
  exports.getElementScrollRestorationEntry = getElementScrollRestorationEntry;
187
- exports.scrollRestorationCache = scrollRestorationCache;
188
194
  exports.setupScrollRestoration = setupScrollRestoration;
189
195
  exports.storageKey = storageKey;
190
196
 
@@ -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, isPlainObject } from './utils'\nimport type { AnyRouter } from './router'\nimport type { ParsedLocation } from './location'\nimport type { NonNullableUpdater } from './utils'\n\nexport type ScrollRestorationEntry = { scrollX: number; scrollY: number }\n\ntype ScrollRestorationByElement = Record<string, ScrollRestorationEntry>\n\ntype ScrollRestorationByKey = Record<string, ScrollRestorationByElement>\n\ntype ScrollRestorationCache = {\n readonly state: ScrollRestorationByKey\n set: (updater: NonNullableUpdater<ScrollRestorationByKey>) => void\n persist: () => void\n}\n\nexport type ScrollRestorationOptions = {\n getKey?: (location: ParsedLocation) => string\n scrollBehavior?: ScrollToOptions['behavior']\n}\n\nfunction getSafeSessionStorage() {\n try {\n return typeof window !== 'undefined' &&\n typeof window.sessionStorage === 'object'\n ? window.sessionStorage\n : undefined\n } catch {\n // silent\n return undefined\n }\n}\n\n// SessionStorage key used to store scroll positions across navigations.\nexport const storageKey = 'tsr-scroll-restoration-v1_3'\n\nfunction createScrollRestorationCache(): ScrollRestorationCache | null {\n const safeSessionStorage = getSafeSessionStorage()\n if (!safeSessionStorage) {\n return null\n }\n\n let state: ScrollRestorationByKey = {}\n\n try {\n const parsed = JSON.parse(safeSessionStorage.getItem(storageKey) || '{}')\n if (isPlainObject(parsed)) {\n state = parsed as ScrollRestorationByKey\n }\n } catch {\n // ignore invalid session storage payloads\n }\n\n const persist = () => {\n try {\n safeSessionStorage.setItem(storageKey, JSON.stringify(state))\n } catch {\n if (process.env.NODE_ENV !== 'production') {\n console.warn(\n '[ts-router] Could not persist scroll restoration state to sessionStorage.',\n )\n }\n }\n }\n\n return {\n get state() {\n return state\n },\n set: (updater) => {\n state = functionalUpdate(updater, state) || state\n },\n persist,\n }\n}\n\nexport const scrollRestorationCache = createScrollRestorationCache()\n\n/**\n * The default `getKey` function for `useScrollRestoration`.\n * It returns the `key` from the location state or the `href` of the location.\n *\n * The `location.href` is used as a fallback to support the use case where the location state is not available like the initial render.\n */\nexport const defaultGetScrollRestorationKey = (location: ParsedLocation) => {\n return location.state.__TSR_key! || location.href\n}\n\nfunction getCssSelector(el: any): string {\n const path = []\n let parent: HTMLElement\n while ((parent = el.parentNode)) {\n path.push(\n `${el.tagName}:nth-child(${Array.prototype.indexOf.call(parent.children, el) + 1})`,\n )\n el = parent\n }\n return `${path.reverse().join(' > ')}`.toLowerCase()\n}\n\nexport function getElementScrollRestorationEntry(\n router: AnyRouter,\n options: (\n | {\n id: string\n getElement?: () => Window | Element | undefined | null\n }\n | {\n id?: string\n getElement: () => Window | Element | undefined | null\n }\n ) & {\n getKey?: (location: ParsedLocation) => string\n },\n): ScrollRestorationEntry | undefined {\n const getKey = options.getKey || defaultGetScrollRestorationKey\n const restoreKey = getKey(router.latestLocation)\n\n if (options.id) {\n return scrollRestorationCache?.state[restoreKey]?.[\n `[${scrollRestorationIdAttribute}=\"${options.id}\"]`\n ]\n }\n\n const element = options.getElement?.()\n if (!element) {\n return\n }\n\n return scrollRestorationCache?.state[restoreKey]?.[\n element instanceof Window ? windowScrollTarget : getCssSelector(element)\n ]\n}\n\nlet ignoreScroll = false\nconst windowScrollTarget = 'window'\nconst scrollRestorationIdAttribute = 'data-scroll-restoration-id'\ntype ScrollTarget = typeof windowScrollTarget | Element\n\nexport function setupScrollRestoration(router: AnyRouter, force?: boolean) {\n if (!scrollRestorationCache && !(isServer ?? router.isServer)) {\n return\n }\n\n const cache = scrollRestorationCache\n\n const shouldScrollRestoration =\n force ?? router.options.scrollRestoration ?? false\n\n if (shouldScrollRestoration) {\n router.isScrollRestoring = true\n }\n\n if (\n (isServer ?? router.isServer) ||\n router.isScrollRestorationSetup ||\n !cache\n ) {\n return\n }\n\n router.isScrollRestorationSetup = true\n ignoreScroll = false\n\n const getKey =\n router.options.getScrollRestorationKey || defaultGetScrollRestorationKey\n const trackedScrollEntries = new Map<ScrollTarget, ScrollRestorationEntry>()\n\n window.history.scrollRestoration = 'manual'\n\n const onScroll = (event: Event) => {\n if (ignoreScroll || !router.isScrollRestoring) {\n return\n }\n\n if (event.target === document || event.target === window) {\n trackedScrollEntries.set(windowScrollTarget, {\n scrollX: window.scrollX || 0,\n scrollY: window.scrollY || 0,\n })\n } else {\n const target = event.target as Element\n trackedScrollEntries.set(target, {\n scrollX: target.scrollLeft || 0,\n scrollY: target.scrollTop || 0,\n })\n }\n }\n\n // Snapshot the current page's tracked scroll targets before navigation or unload.\n const snapshotCurrentScrollTargets = (restoreKey?: string) => {\n if (\n !router.isScrollRestoring ||\n !restoreKey ||\n trackedScrollEntries.size === 0 ||\n !cache\n ) {\n return\n }\n\n const keyEntry = (cache.state[restoreKey] ||=\n {} as ScrollRestorationByElement)\n\n for (const [target, position] of trackedScrollEntries) {\n let selector: string | undefined\n\n if (target === windowScrollTarget) {\n selector = windowScrollTarget\n } else if (target.isConnected) {\n const attrId = target.getAttribute(scrollRestorationIdAttribute)\n selector = attrId\n ? `[${scrollRestorationIdAttribute}=\"${attrId}\"]`\n : getCssSelector(target)\n }\n\n if (!selector) {\n continue\n }\n\n keyEntry[selector] = position\n }\n }\n\n document.addEventListener('scroll', onScroll, true)\n router.subscribe('onBeforeLoad', (event) => {\n snapshotCurrentScrollTargets(\n event.fromLocation ? getKey(event.fromLocation) : undefined,\n )\n trackedScrollEntries.clear()\n })\n window.addEventListener('pagehide', () => {\n snapshotCurrentScrollTargets(\n getKey(\n router.stores.resolvedLocation.get() ?? router.stores.location.get(),\n ),\n )\n cache.persist()\n })\n\n // Restore destination scroll after the new route has rendered.\n router.subscribe('onRendered', (event) => {\n const cacheKey = getKey(event.toLocation)\n const behavior = router.options.scrollRestorationBehavior\n const scrollToTopSelectors = router.options.scrollToTopSelectors\n trackedScrollEntries.clear()\n\n if (!router.resetNextScroll) {\n router.resetNextScroll = true\n return\n }\n\n if (\n typeof router.options.scrollRestoration === 'function' &&\n !router.options.scrollRestoration({ location: router.latestLocation })\n ) {\n return\n }\n\n ignoreScroll = true\n\n try {\n const elementEntries = router.isScrollRestoring\n ? cache.state[cacheKey]\n : undefined\n let restored = false\n\n if (elementEntries) {\n for (const elementSelector in elementEntries) {\n const entry = elementEntries[elementSelector]\n\n if (!isPlainObject(entry)) {\n continue\n }\n\n const { scrollX, scrollY } = entry as {\n scrollX?: unknown\n scrollY?: unknown\n }\n\n if (!Number.isFinite(scrollX) || !Number.isFinite(scrollY)) {\n continue\n }\n\n if (elementSelector === windowScrollTarget) {\n window.scrollTo({\n top: scrollY as number,\n left: scrollX as number,\n behavior,\n })\n restored = true\n } else if (elementSelector) {\n let element\n\n try {\n element = document.querySelector(elementSelector)\n } catch {\n continue\n }\n\n if (element) {\n element.scrollLeft = scrollX as number\n element.scrollTop = scrollY as number\n restored = true\n }\n }\n }\n }\n\n if (!restored) {\n const hash = router.history.location.hash.slice(1)\n\n if (hash) {\n const hashScrollIntoViewOptions =\n window.history.state?.__hashScrollIntoViewOptions ?? true\n\n if (hashScrollIntoViewOptions) {\n const el = document.getElementById(hash)\n if (el) {\n el.scrollIntoView(hashScrollIntoViewOptions)\n }\n }\n } else {\n const scrollOptions = {\n top: 0,\n left: 0,\n behavior,\n }\n\n window.scrollTo(scrollOptions)\n if (scrollToTopSelectors) {\n for (const selector of scrollToTopSelectors) {\n if (selector === windowScrollTarget) continue\n const element =\n typeof selector === 'function'\n ? selector()\n : document.querySelector(selector)\n if (element) {\n element.scrollTo(scrollOptions)\n }\n }\n }\n }\n }\n } finally {\n ignoreScroll = false\n }\n\n if (router.isScrollRestoring) {\n cache.set((state) => {\n state[cacheKey] ||= {} as ScrollRestorationByElement\n return state\n })\n }\n })\n}\n"],"mappings":";;;AAuBA,SAAS,wBAAwB;AAC/B,KAAI;AACF,SAAO,OAAO,WAAW,eACvB,OAAO,OAAO,mBAAmB,WAC/B,OAAO,iBACP,KAAA;SACE;AAEN;;;AAKJ,MAAa,aAAa;AAE1B,SAAS,+BAA8D;CACrE,MAAM,qBAAqB,uBAAuB;AAClD,KAAI,CAAC,mBACH,QAAO;CAGT,IAAI,QAAgC,EAAE;AAEtC,KAAI;EACF,MAAM,SAAS,KAAK,MAAM,mBAAmB,QAAA,8BAAmB,IAAI,KAAK;AACzE,MAAI,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,MAAa,yBAAyB,8BAA8B;;;;;;;AAQpE,MAAa,kCAAkC,aAA6B;AAC1E,QAAO,SAAS,MAAM,aAAc,SAAS;;AAG/C,SAAS,eAAe,IAAiB;CACvC,MAAM,OAAO,EAAE;CACf,IAAI;AACJ,QAAQ,SAAS,GAAG,YAAa;AAC/B,OAAK,KACH,GAAG,GAAG,QAAQ,aAAa,MAAM,UAAU,QAAQ,KAAK,OAAO,UAAU,GAAG,GAAG,EAAE,GAClF;AACD,OAAK;;AAEP,QAAO,GAAG,KAAK,SAAS,CAAC,KAAK,MAAM,GAAG,aAAa;;AAGtD,SAAgB,iCACd,QACA,SAYoC;CAEpC,MAAM,cADS,QAAQ,UAAU,gCACP,OAAO,eAAe;AAEhD,KAAI,QAAQ,GACV,QAAO,wBAAwB,MAAM,cACnC,IAAI,6BAA6B,IAAI,QAAQ,GAAG;CAIpD,MAAM,UAAU,QAAQ,cAAc;AACtC,KAAI,CAAC,QACH;AAGF,QAAO,wBAAwB,MAAM,cACnC,mBAAmB,SAAS,qBAAqB,eAAe,QAAQ;;AAI5E,IAAI,eAAe;AACnB,MAAM,qBAAqB;AAC3B,MAAM,+BAA+B;AAGrC,SAAgB,uBAAuB,QAAmB,OAAiB;AACzE,KAAI,CAAC,0BAA0B,EAAE,+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,KAAK,IAAI,OAAO,OAAO,SAAS,KAAK,CACrE,CACF;AACD,QAAM,SAAS;GACf;AAGF,QAAO,UAAU,eAAe,UAAU;EACxC,MAAM,WAAW,OAAO,MAAM,WAAW;EACzC,MAAM,WAAW,OAAO,QAAQ;EAChC,MAAM,uBAAuB,OAAO,QAAQ;AAC5C,uBAAqB,OAAO;AAE5B,MAAI,CAAC,OAAO,iBAAiB;AAC3B,UAAO,kBAAkB;AACzB;;AAGF,MACE,OAAO,OAAO,QAAQ,sBAAsB,cAC5C,CAAC,OAAO,QAAQ,kBAAkB,EAAE,UAAU,OAAO,gBAAgB,CAAC,CAEtE;AAGF,iBAAe;AAEf,MAAI;GACF,MAAM,iBAAiB,OAAO,oBAC1B,MAAM,MAAM,YACZ,KAAA;GACJ,IAAI,WAAW;AAEf,OAAI,eACF,MAAK,MAAM,mBAAmB,gBAAgB;IAC5C,MAAM,QAAQ,eAAe;AAE7B,QAAI,CAAC,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"}
1
+ {"version":3,"file":"scroll-restoration.cjs","names":[],"sources":["../../src/scroll-restoration.ts"],"sourcesContent":["import { isServer } from '@tanstack/router-core/isServer'\nimport { locationHistoryActions } from './router'\nimport type { AnyRouter } from './router'\nimport type { ParsedLocation } from './location'\n\nexport type ScrollRestorationEntry = { scrollX: number; scrollY: number }\n\ntype ScrollRestorationByElement = Record<string, ScrollRestorationEntry>\n\ntype ScrollRestorationByKey = Record<string, ScrollRestorationByElement>\n\nexport type ScrollRestorationOptions = {\n getKey?: (location: ParsedLocation) => string\n scrollBehavior?: ScrollToOptions['behavior']\n}\n\nfunction getSafeSessionStorage() {\n try {\n // Accessing sessionStorage itself can throw SecurityError in locked-down\n // contexts, e.g. sandboxed/opaque origins or blocked storage policies.\n return sessionStorage\n } catch {\n return\n }\n}\n\n// SessionStorage key used to store scroll positions across navigations.\nexport const storageKey = 'tsr-scroll-restoration-v1_3'\nconst safeSessionStorage = getSafeSessionStorage()\n\nfunction createScrollRestorationCache() {\n try {\n return JSON.parse(\n safeSessionStorage?.getItem(storageKey) || '{}',\n ) as ScrollRestorationByKey\n } catch {\n // ignore invalid session storage payloads\n return {}\n }\n}\n\nfunction persistScrollRestorationCache() {\n try {\n safeSessionStorage?.setItem(\n storageKey,\n JSON.stringify(scrollRestorationCache),\n )\n } catch {\n if (process.env.NODE_ENV !== 'production') {\n console.warn(\n '[ts-router] Could not persist scroll restoration state to sessionStorage.',\n )\n }\n }\n}\n\nconst scrollRestorationCache = /* @__PURE__ */ createScrollRestorationCache()\nconst scrollRestorationIdAttribute = 'data-scroll-restoration-id'\n\n/**\n * The default `getKey` function for `useScrollRestoration`.\n * It returns the `key` from the location state or the `href` of the location.\n *\n * The `location.href` is used as a fallback to support the use case where the location state is not available like the initial render.\n */\nexport const defaultGetScrollRestorationKey = (location: ParsedLocation) => {\n return location.state.__TSR_key! || location.href\n}\n\nfunction getScrollRestorationSelector(element: Element): string {\n const attrId = element.getAttribute(scrollRestorationIdAttribute)\n if (attrId) {\n return `[${scrollRestorationIdAttribute}=\"${attrId}\"]`\n }\n\n let selector = ''\n let el: any = element\n let parent: HTMLElement\n\n while ((parent = el.parentNode)) {\n let index = 1\n let sibling = el\n while ((sibling = sibling.previousElementSibling)) {\n index++\n }\n\n const part = `${el.localName}:nth-child(${index})`\n selector = selector ? `${part} > ${selector}` : part\n el = parent\n }\n\n return selector\n}\n\nexport function getElementScrollRestorationEntry(\n router: AnyRouter,\n options: (\n | {\n id: string\n getElement?: () => Window | Element | undefined | null\n }\n | {\n id?: string\n getElement: () => Window | Element | undefined | null\n }\n ) & {\n getKey?: (location: ParsedLocation) => string\n },\n): ScrollRestorationEntry | undefined {\n const getKey = options.getKey || defaultGetScrollRestorationKey\n const restoreKey = getKey(router.latestLocation)\n const entries = scrollRestorationCache[restoreKey]\n\n if (!entries) {\n return\n }\n\n if (options.id) {\n return entries[`[${scrollRestorationIdAttribute}=\"${options.id}\"]`]\n }\n\n const element = options.getElement?.()\n if (!element) {\n return\n }\n\n return entries[\n element === window\n ? windowScrollTarget\n : getScrollRestorationSelector(element as Element)\n ]\n}\n\nlet ignoreScroll = false\nconst windowScrollTarget = 'window'\ntype ScrollTarget = typeof windowScrollTarget | Element\n\nfunction getElement(selector: string | (() => Element | null | undefined)) {\n try {\n return typeof selector === 'function'\n ? selector()\n : document.querySelector(selector)\n } catch {}\n return\n}\n\nfunction getScrollToTopElements(\n scrollToTopSelectors: NonNullable<\n AnyRouter['options']['scrollToTopSelectors']\n >,\n): Array<Element> {\n const elements: Array<Element> = []\n\n for (const selector of scrollToTopSelectors) {\n if (selector === windowScrollTarget) {\n continue\n }\n\n const element = getElement(selector)\n if (element) {\n elements.push(element)\n }\n }\n\n return elements\n}\n\nexport function setupScrollRestoration(router: AnyRouter, force?: boolean) {\n // Keep hash/top scrolling active even when sessionStorage is unavailable.\n\n if (force ?? router.options.scrollRestoration) {\n router.isScrollRestoring = true\n }\n\n if ((isServer ?? router.isServer) || router.isScrollRestorationSetup) {\n return\n }\n\n router.isScrollRestorationSetup = true\n ignoreScroll = false\n\n const getKey =\n router.options.getScrollRestorationKey || defaultGetScrollRestorationKey\n const trackedScrollEntries = new Map<ScrollTarget, ScrollRestorationEntry>()\n const setTrackedScrollEntry = (\n target: ScrollTarget,\n scrollX: number,\n scrollY: number,\n ) => {\n const entry =\n trackedScrollEntries.get(target) || ({} as ScrollRestorationEntry)\n entry.scrollX = scrollX\n entry.scrollY = scrollY\n trackedScrollEntries.set(target, entry)\n }\n\n history.scrollRestoration = 'manual'\n\n const onScroll = (event: Event) => {\n if (ignoreScroll || !router.isScrollRestoring) {\n return\n }\n\n if (event.target === document) {\n setTrackedScrollEntry(windowScrollTarget, scrollX, scrollY)\n } else {\n const target = event.target as Element\n setTrackedScrollEntry(target, target.scrollLeft, target.scrollTop)\n }\n }\n\n // Snapshot the current page's tracked scroll targets before navigation or unload.\n const snapshotCurrentScrollTargets = (restoreKey: string) => {\n if (!router.isScrollRestoring) {\n return\n }\n\n const keyEntry = (scrollRestorationCache[restoreKey] ||=\n {} as ScrollRestorationByElement)\n\n for (const [target, position] of trackedScrollEntries) {\n if (target === windowScrollTarget) {\n keyEntry[windowScrollTarget] = position\n } else if (target.isConnected) {\n keyEntry[getScrollRestorationSelector(target)] = position\n }\n }\n }\n\n document.addEventListener('scroll', onScroll, true)\n router.subscribe('onBeforeLoad', (event) => {\n if (event.fromLocation) {\n snapshotCurrentScrollTargets(getKey(event.fromLocation))\n }\n trackedScrollEntries.clear()\n })\n addEventListener('pagehide', () => {\n snapshotCurrentScrollTargets(\n getKey(\n router.stores.resolvedLocation.get() ?? router.stores.location.get(),\n ),\n )\n persistScrollRestorationCache()\n })\n\n // Restore destination scroll after the new route has rendered.\n router.subscribe('onRendered', (event) => {\n const behavior = router.options.scrollRestorationBehavior\n const scrollToTopSelectors = router.options.scrollToTopSelectors\n const shouldResetScroll = router.resetNextScroll\n let scrollToTopElements: Array<Element> | undefined\n trackedScrollEntries.clear()\n\n if (!shouldResetScroll) {\n router.resetNextScroll = true\n }\n\n if (\n typeof router.options.scrollRestoration === 'function' &&\n !router.options.scrollRestoration({ location: router.latestLocation })\n ) {\n return\n }\n\n const cacheKey = getKey(event.toLocation)\n const fromCacheKey = event.fromLocation && getKey(event.fromLocation)\n\n if (router.isScrollRestoring && fromCacheKey && fromCacheKey !== cacheKey) {\n const fromElementEntries = scrollRestorationCache[fromCacheKey]\n\n if (fromElementEntries) {\n let toElementEntries = scrollRestorationCache[cacheKey]\n\n for (const elementSelector in fromElementEntries) {\n if (elementSelector === windowScrollTarget) {\n if (shouldResetScroll) {\n continue\n }\n } else {\n const element = getElement(elementSelector)\n if (!element) {\n continue\n }\n\n if (shouldResetScroll && scrollToTopSelectors) {\n scrollToTopElements ??=\n getScrollToTopElements(scrollToTopSelectors)\n if (scrollToTopElements.includes(element)) {\n continue\n }\n }\n }\n\n if (!toElementEntries) {\n toElementEntries = scrollRestorationCache[cacheKey] =\n {} as ScrollRestorationByElement\n }\n\n toElementEntries[elementSelector] ??=\n fromElementEntries[elementSelector]!\n }\n }\n }\n\n ignoreScroll = true\n\n try {\n const hash = event.toLocation.hash\n const hashScrollIntoViewOptions =\n event.toLocation.state.__hashScrollIntoViewOptions ?? true\n let windowRestored = false\n\n if (shouldResetScroll) {\n const action = locationHistoryActions.get(event.toLocation)\n const skipWindowRestore =\n hash &&\n hashScrollIntoViewOptions &&\n (action === 'PUSH' || action === 'REPLACE')\n\n const elementEntries = router.isScrollRestoring\n ? scrollRestorationCache[cacheKey]\n : undefined\n\n if (elementEntries) {\n for (const elementSelector in elementEntries) {\n const { scrollX, scrollY } = elementEntries[elementSelector]!\n\n if (elementSelector === windowScrollTarget) {\n if (skipWindowRestore) {\n continue\n }\n\n scrollTo({\n top: scrollY,\n left: scrollX,\n behavior,\n })\n windowRestored = true\n } else {\n const element = getElement(elementSelector)\n if (element) {\n element.scrollLeft = scrollX\n element.scrollTop = scrollY\n }\n }\n }\n }\n\n if (!windowRestored && !hash) {\n const scrollOptions = {\n top: 0,\n left: 0,\n behavior,\n }\n\n scrollTo(scrollOptions)\n if (scrollToTopSelectors) {\n scrollToTopElements ??= getScrollToTopElements(scrollToTopSelectors)\n for (const element of scrollToTopElements) {\n element.scrollTo(scrollOptions)\n }\n }\n }\n }\n\n if (!windowRestored && hash && hashScrollIntoViewOptions) {\n document.getElementById(hash)?.scrollIntoView(hashScrollIntoViewOptions)\n }\n } finally {\n ignoreScroll = false\n }\n })\n}\n"],"mappings":";;;AAgBA,SAAS,wBAAwB;AAC/B,KAAI;AAGF,SAAO;SACD;AACN;;;AAKJ,MAAa,aAAa;AAC1B,MAAM,qBAAqB,uBAAuB;AAElD,SAAS,+BAA+B;AACtC,KAAI;AACF,SAAO,KAAK,MACV,oBAAoB,QAAA,8BAAmB,IAAI,KAC5C;SACK;AAEN,SAAO,EAAE;;;AAIb,SAAS,gCAAgC;AACvC,KAAI;AACF,sBAAoB,QAClB,YACA,KAAK,UAAU,uBAAuB,CACvC;SACK;AACN,MAAA,QAAA,IAAA,aAA6B,aAC3B,SAAQ,KACN,4EACD;;;AAKP,MAAM,yBAAyC,8CAA8B;AAC7E,MAAM,+BAA+B;;;;;;;AAQrC,MAAa,kCAAkC,aAA6B;AAC1E,QAAO,SAAS,MAAM,aAAc,SAAS;;AAG/C,SAAS,6BAA6B,SAA0B;CAC9D,MAAM,SAAS,QAAQ,aAAa,6BAA6B;AACjE,KAAI,OACF,QAAO,IAAI,6BAA6B,IAAI,OAAO;CAGrD,IAAI,WAAW;CACf,IAAI,KAAU;CACd,IAAI;AAEJ,QAAQ,SAAS,GAAG,YAAa;EAC/B,IAAI,QAAQ;EACZ,IAAI,UAAU;AACd,SAAQ,UAAU,QAAQ,uBACxB;EAGF,MAAM,OAAO,GAAG,GAAG,UAAU,aAAa,MAAM;AAChD,aAAW,WAAW,GAAG,KAAK,KAAK,aAAa;AAChD,OAAK;;AAGP,QAAO;;AAGT,SAAgB,iCACd,QACA,SAYoC;CAGpC,MAAM,UAAU,wBAFD,QAAQ,UAAU,gCACP,OAAO,eAAe;AAGhD,KAAI,CAAC,QACH;AAGF,KAAI,QAAQ,GACV,QAAO,QAAQ,IAAI,6BAA6B,IAAI,QAAQ,GAAG;CAGjE,MAAM,UAAU,QAAQ,cAAc;AACtC,KAAI,CAAC,QACH;AAGF,QAAO,QACL,YAAY,SACR,qBACA,6BAA6B,QAAmB;;AAIxD,IAAI,eAAe;AACnB,MAAM,qBAAqB;AAG3B,SAAS,WAAW,UAAuD;AACzE,KAAI;AACF,SAAO,OAAO,aAAa,aACvB,UAAU,GACV,SAAS,cAAc,SAAS;SAC9B;;AAIV,SAAS,uBACP,sBAGgB;CAChB,MAAM,WAA2B,EAAE;AAEnC,MAAK,MAAM,YAAY,sBAAsB;AAC3C,MAAI,aAAa,mBACf;EAGF,MAAM,UAAU,WAAW,SAAS;AACpC,MAAI,QACF,UAAS,KAAK,QAAQ;;AAI1B,QAAO;;AAGT,SAAgB,uBAAuB,QAAmB,OAAiB;AAGzE,KAAI,SAAS,OAAO,QAAQ,kBAC1B,QAAO,oBAAoB;AAG7B,MAAK,+BAAA,YAAY,OAAO,aAAa,OAAO,yBAC1C;AAGF,QAAO,2BAA2B;AAClC,gBAAe;CAEf,MAAM,SACJ,OAAO,QAAQ,2BAA2B;CAC5C,MAAM,uCAAuB,IAAI,KAA2C;CAC5E,MAAM,yBACJ,QACA,SACA,YACG;EACH,MAAM,QACJ,qBAAqB,IAAI,OAAO,IAAK,EAAE;AACzC,QAAM,UAAU;AAChB,QAAM,UAAU;AAChB,uBAAqB,IAAI,QAAQ,MAAM;;AAGzC,SAAQ,oBAAoB;CAE5B,MAAM,YAAY,UAAiB;AACjC,MAAI,gBAAgB,CAAC,OAAO,kBAC1B;AAGF,MAAI,MAAM,WAAW,SACnB,uBAAsB,oBAAoB,SAAS,QAAQ;OACtD;GACL,MAAM,SAAS,MAAM;AACrB,yBAAsB,QAAQ,OAAO,YAAY,OAAO,UAAU;;;CAKtE,MAAM,gCAAgC,eAAuB;AAC3D,MAAI,CAAC,OAAO,kBACV;EAGF,MAAM,WAAY,uBAAuB,gBACvC,EAAE;AAEJ,OAAK,MAAM,CAAC,QAAQ,aAAa,qBAC/B,KAAI,WAAW,mBACb,UAAS,sBAAsB;WACtB,OAAO,YAChB,UAAS,6BAA6B,OAAO,IAAI;;AAKvD,UAAS,iBAAiB,UAAU,UAAU,KAAK;AACnD,QAAO,UAAU,iBAAiB,UAAU;AAC1C,MAAI,MAAM,aACR,8BAA6B,OAAO,MAAM,aAAa,CAAC;AAE1D,uBAAqB,OAAO;GAC5B;AACF,kBAAiB,kBAAkB;AACjC,+BACE,OACE,OAAO,OAAO,iBAAiB,KAAK,IAAI,OAAO,OAAO,SAAS,KAAK,CACrE,CACF;AACD,iCAA+B;GAC/B;AAGF,QAAO,UAAU,eAAe,UAAU;EACxC,MAAM,WAAW,OAAO,QAAQ;EAChC,MAAM,uBAAuB,OAAO,QAAQ;EAC5C,MAAM,oBAAoB,OAAO;EACjC,IAAI;AACJ,uBAAqB,OAAO;AAE5B,MAAI,CAAC,kBACH,QAAO,kBAAkB;AAG3B,MACE,OAAO,OAAO,QAAQ,sBAAsB,cAC5C,CAAC,OAAO,QAAQ,kBAAkB,EAAE,UAAU,OAAO,gBAAgB,CAAC,CAEtE;EAGF,MAAM,WAAW,OAAO,MAAM,WAAW;EACzC,MAAM,eAAe,MAAM,gBAAgB,OAAO,MAAM,aAAa;AAErE,MAAI,OAAO,qBAAqB,gBAAgB,iBAAiB,UAAU;GACzE,MAAM,qBAAqB,uBAAuB;AAElD,OAAI,oBAAoB;IACtB,IAAI,mBAAmB,uBAAuB;AAE9C,SAAK,MAAM,mBAAmB,oBAAoB;AAChD,SAAI,oBAAoB;UAClB,kBACF;YAEG;MACL,MAAM,UAAU,WAAW,gBAAgB;AAC3C,UAAI,CAAC,QACH;AAGF,UAAI,qBAAqB,sBAAsB;AAC7C,+BACE,uBAAuB,qBAAqB;AAC9C,WAAI,oBAAoB,SAAS,QAAQ,CACvC;;;AAKN,SAAI,CAAC,iBACH,oBAAmB,uBAAuB,YACxC,EAAE;AAGN,sBAAiB,qBACf,mBAAmB;;;;AAK3B,iBAAe;AAEf,MAAI;GACF,MAAM,OAAO,MAAM,WAAW;GAC9B,MAAM,4BACJ,MAAM,WAAW,MAAM,+BAA+B;GACxD,IAAI,iBAAiB;AAErB,OAAI,mBAAmB;IACrB,MAAM,SAAS,eAAA,uBAAuB,IAAI,MAAM,WAAW;IAC3D,MAAM,oBACJ,QACA,8BACC,WAAW,UAAU,WAAW;IAEnC,MAAM,iBAAiB,OAAO,oBAC1B,uBAAuB,YACvB,KAAA;AAEJ,QAAI,eACF,MAAK,MAAM,mBAAmB,gBAAgB;KAC5C,MAAM,EAAE,SAAS,YAAY,eAAe;AAE5C,SAAI,oBAAoB,oBAAoB;AAC1C,UAAI,kBACF;AAGF,eAAS;OACP,KAAK;OACL,MAAM;OACN;OACD,CAAC;AACF,uBAAiB;YACZ;MACL,MAAM,UAAU,WAAW,gBAAgB;AAC3C,UAAI,SAAS;AACX,eAAQ,aAAa;AACrB,eAAQ,YAAY;;;;AAM5B,QAAI,CAAC,kBAAkB,CAAC,MAAM;KAC5B,MAAM,gBAAgB;MACpB,KAAK;MACL,MAAM;MACN;MACD;AAED,cAAS,cAAc;AACvB,SAAI,sBAAsB;AACxB,8BAAwB,uBAAuB,qBAAqB;AACpE,WAAK,MAAM,WAAW,oBACpB,SAAQ,SAAS,cAAc;;;;AAMvC,OAAI,CAAC,kBAAkB,QAAQ,0BAC7B,UAAS,eAAe,KAAK,EAAE,eAAe,0BAA0B;YAElE;AACR,kBAAe;;GAEjB"}
@@ -1,23 +1,14 @@
1
1
  import { AnyRouter } from './router.cjs';
2
2
  import { ParsedLocation } from './location.cjs';
3
- import { NonNullableUpdater } from './utils.cjs';
4
3
  export type ScrollRestorationEntry = {
5
4
  scrollX: number;
6
5
  scrollY: number;
7
6
  };
8
- type ScrollRestorationByElement = Record<string, ScrollRestorationEntry>;
9
- type ScrollRestorationByKey = Record<string, ScrollRestorationByElement>;
10
- type ScrollRestorationCache = {
11
- readonly state: ScrollRestorationByKey;
12
- set: (updater: NonNullableUpdater<ScrollRestorationByKey>) => void;
13
- persist: () => void;
14
- };
15
7
  export type ScrollRestorationOptions = {
16
8
  getKey?: (location: ParsedLocation) => string;
17
9
  scrollBehavior?: ScrollToOptions['behavior'];
18
10
  };
19
11
  export declare const storageKey = "tsr-scroll-restoration-v1_3";
20
- export declare const scrollRestorationCache: ScrollRestorationCache | null;
21
12
  /**
22
13
  * The default `getKey` function for `useScrollRestoration`.
23
14
  * It returns the `key` from the location state or the `href` of the location.
@@ -35,4 +26,3 @@ export declare function getElementScrollRestorationEntry(router: AnyRouter, opti
35
26
  getKey?: (location: ParsedLocation) => string;
36
27
  }): ScrollRestorationEntry | undefined;
37
28
  export declare function setupScrollRestoration(router: AnyRouter, force?: boolean): void;
38
- export {};
@@ -40,8 +40,7 @@ export type { Redirect, RedirectOptions, RedirectOptionsRoute, RedirectFnRoute,
40
40
  export { redirect, isRedirect, isResolvedRedirect, parseRedirect, } from './redirect.js';
41
41
  export type { NotFoundError } from './not-found.js';
42
42
  export { isNotFound, notFound } from './not-found.js';
43
- export { defaultGetScrollRestorationKey, getElementScrollRestorationEntry, storageKey, scrollRestorationCache, setupScrollRestoration, } from './scroll-restoration.js';
44
- export { handleHashScroll } from './hash-scroll.js';
43
+ export { defaultGetScrollRestorationKey, getElementScrollRestorationEntry, storageKey, setupScrollRestoration, } from './scroll-restoration.js';
45
44
  export type { ScrollRestorationOptions, ScrollRestorationEntry, } from './scroll-restoration.js';
46
45
  export type { ValidateFromPath, ValidateToPath, ValidateSearch, ValidateParams, InferFrom, InferTo, InferMaskTo, InferMaskFrom, ValidateNavigateOptions, ValidateNavigateOptionsArray, ValidateRedirectOptions, ValidateRedirectOptionsArray, ValidateId, InferStrict, InferShouldThrow, InferSelected, ValidateUseSearchResult, ValidateUseParamsResult, } from './typePrimitives.js';
47
46
  export type { AnySerializationAdapter, SerializationAdapter, ValidateSerializableInput, SerializerExtensions, ValidateSerializable, RegisteredSerializableInput, SerializableExtensions, DefaultSerializable, Serializable, TSR_SERIALIZABLE, TsrSerializable, SerializationError, } from './ssr/serializer/transformer.js';
package/dist/esm/index.js CHANGED
@@ -2,7 +2,7 @@ import { DEFAULT_PROTOCOL_ALLOWLIST, buildDevStylesUrl, createControlledPromise,
2
2
  import { invariant } from "./invariant.js";
3
3
  import { cleanPath, exactPathTest, interpolatePath, joinPaths, removeTrailingSlash, resolvePath, trimPath, trimPathLeft, trimPathRight } from "./path.js";
4
4
  import { isNotFound, notFound } from "./not-found.js";
5
- import { defaultGetScrollRestorationKey, getElementScrollRestorationEntry, scrollRestorationCache, setupScrollRestoration, storageKey } from "./scroll-restoration.js";
5
+ import { defaultGetScrollRestorationKey, getElementScrollRestorationEntry, setupScrollRestoration, storageKey } from "./scroll-restoration.js";
6
6
  import { decode, encode } from "./qss.js";
7
7
  import { defaultParseSearch, defaultStringifySearch, parseSearchWith, stringifySearchWith } from "./searchParams.js";
8
8
  import { rootRouteId } from "./root.js";
@@ -17,8 +17,7 @@ import { isMatch } from "./Matches.js";
17
17
  import { BaseRootRoute, BaseRoute, BaseRouteApi } from "./route.js";
18
18
  import { createRouterConfig } from "./config.js";
19
19
  import { retainSearchParams, stripSearchParams } from "./searchMiddleware.js";
20
- import { handleHashScroll } from "./hash-scroll.js";
21
20
  import { createSerializationAdapter, makeSerovalPlugin, makeSsrSerovalPlugin } from "./ssr/serializer/transformer.js";
22
21
  import { RawStream, createRawStreamDeserializePlugin, createRawStreamRPCPlugin } from "./ssr/serializer/RawStream.js";
23
22
  import { defaultSerovalPlugins } from "./ssr/serializer/seroval-plugins.js";
24
- export { BaseRootRoute, BaseRoute, BaseRouteApi, DEFAULT_PROTOCOL_ALLOWLIST, PathParamError, RawStream, RouterCore, SearchParamError, TSR_DEFERRED_PROMISE, buildDevStylesUrl, cleanPath, composeRewrites, createControlledPromise, createInlineCssStyleAsset, createNonReactiveMutableStore, createNonReactiveReadonlyStore, createRawStreamDeserializePlugin, createRawStreamRPCPlugin, createRouterConfig, createSerializationAdapter, decode, deepEqual, defaultGetScrollRestorationKey, defaultParseSearch, defaultSerializeError, defaultSerovalPlugins, defaultStringifySearch, defer, encode, escapeHtml, exactPathTest, executeRewriteInput, functionalUpdate, getAssetCrossOrigin, getElementScrollRestorationEntry, getInitialRouterState, getLocationChangeInfo, getMatchedRoutes, getStylesheetHref, handleHashScroll, hasKeys, interpolatePath, invariant, isDangerousProtocol, isInlinableStylesheet, isMatch, isModuleNotFoundError, isNotFound, isPlainArray, isPlainObject, isRedirect, isResolvedRedirect, joinPaths, lazyFn, makeSerovalPlugin, makeSsrSerovalPlugin, notFound, parseRedirect, parseSearchWith, preloadWarning, redirect, removeTrailingSlash, replaceEqualDeep, resolveManifestAssetLink, resolvePath, retainSearchParams, rootRouteId, scrollRestorationCache, setupScrollRestoration, storageKey, stringifySearchWith, stripSearchParams, trailingSlashOptions, trimPath, trimPathLeft, trimPathRight };
23
+ export { BaseRootRoute, BaseRoute, BaseRouteApi, DEFAULT_PROTOCOL_ALLOWLIST, PathParamError, RawStream, RouterCore, SearchParamError, TSR_DEFERRED_PROMISE, buildDevStylesUrl, cleanPath, composeRewrites, createControlledPromise, createInlineCssStyleAsset, createNonReactiveMutableStore, createNonReactiveReadonlyStore, createRawStreamDeserializePlugin, createRawStreamRPCPlugin, createRouterConfig, createSerializationAdapter, decode, deepEqual, defaultGetScrollRestorationKey, defaultParseSearch, defaultSerializeError, defaultSerovalPlugins, defaultStringifySearch, defer, encode, escapeHtml, exactPathTest, executeRewriteInput, functionalUpdate, getAssetCrossOrigin, getElementScrollRestorationEntry, getInitialRouterState, getLocationChangeInfo, getMatchedRoutes, getStylesheetHref, hasKeys, interpolatePath, invariant, isDangerousProtocol, isInlinableStylesheet, isMatch, isModuleNotFoundError, isNotFound, isPlainArray, isPlainObject, isRedirect, isResolvedRedirect, joinPaths, lazyFn, makeSerovalPlugin, makeSsrSerovalPlugin, notFound, parseRedirect, parseSearchWith, preloadWarning, redirect, removeTrailingSlash, replaceEqualDeep, resolveManifestAssetLink, resolvePath, retainSearchParams, rootRouteId, setupScrollRestoration, storageKey, stringifySearchWith, stripSearchParams, trailingSlashOptions, trimPath, trimPathLeft, trimPathRight };
@@ -1,6 +1,5 @@
1
1
  import { LocationRewrite } from './router.js';
2
2
  /** Compose multiple rewrite pairs into a single in/out rewrite. */
3
- /** Compose multiple rewrite pairs into a single in/out rewrite. */
4
3
  export declare function composeRewrites(rewrites: Array<LocationRewrite>): {
5
4
  input: ({ url }: {
6
5
  url: URL;
@@ -10,7 +9,6 @@ export declare function composeRewrites(rewrites: Array<LocationRewrite>): {
10
9
  }) => URL;
11
10
  };
12
11
  /** Create a rewrite pair that strips/adds a basepath on input/output. */
13
- /** Create a rewrite pair that strips/adds a basepath on input/output. */
14
12
  export declare function rewriteBasepath(opts: {
15
13
  basepath: string;
16
14
  caseSensitive?: boolean;
@@ -23,8 +21,6 @@ export declare function rewriteBasepath(opts: {
23
21
  }) => URL;
24
22
  };
25
23
  /** Execute a location input rewrite if provided. */
26
- /** Execute a location input rewrite if provided. */
27
24
  export declare function executeRewriteInput(rewrite: LocationRewrite | undefined, url: URL): URL;
28
25
  /** Execute a location output rewrite if provided. */
29
- /** Execute a location output rewrite if provided. */
30
26
  export declare function executeRewriteOutput(rewrite: LocationRewrite | undefined, url: URL): URL;
@@ -1,7 +1,6 @@
1
1
  import { joinPaths, trimPath } from "./path.js";
2
2
  //#region src/rewrite.ts
3
3
  /** Compose multiple rewrite pairs into a single in/out rewrite. */
4
- /** Compose multiple rewrite pairs into a single in/out rewrite. */
5
4
  function composeRewrites(rewrites) {
6
5
  return {
7
6
  input: ({ url }) => {
@@ -15,13 +14,11 @@ function composeRewrites(rewrites) {
15
14
  };
16
15
  }
17
16
  /** Create a rewrite pair that strips/adds a basepath on input/output. */
18
- /** Create a rewrite pair that strips/adds a basepath on input/output. */
19
17
  function rewriteBasepath(opts) {
20
18
  const trimmedBasepath = trimPath(opts.basepath);
21
19
  const normalizedBasepath = `/${trimmedBasepath}`;
22
- const normalizedBasepathWithSlash = `${normalizedBasepath}/`;
23
20
  const checkBasepath = opts.caseSensitive ? normalizedBasepath : normalizedBasepath.toLowerCase();
24
- const checkBasepathWithSlash = opts.caseSensitive ? normalizedBasepathWithSlash : normalizedBasepathWithSlash.toLowerCase();
21
+ const checkBasepathWithSlash = `${checkBasepath}/`;
25
22
  return {
26
23
  input: ({ url }) => {
27
24
  const pathname = opts.caseSensitive ? url.pathname : url.pathname.toLowerCase();
@@ -40,7 +37,6 @@ function rewriteBasepath(opts) {
40
37
  };
41
38
  }
42
39
  /** Execute a location input rewrite if provided. */
43
- /** Execute a location input rewrite if provided. */
44
40
  function executeRewriteInput(rewrite, url) {
45
41
  const res = rewrite?.input?.({ url });
46
42
  if (res) {
@@ -50,7 +46,6 @@ function executeRewriteInput(rewrite, url) {
50
46
  return url;
51
47
  }
52
48
  /** Execute a location output rewrite if provided. */
53
- /** Execute a location output rewrite if provided. */
54
49
  function executeRewriteOutput(rewrite, url) {
55
50
  const res = rewrite?.output?.({ url });
56
51
  if (res) {