@tanstack/solid-router 1.112.18 → 1.114.2
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.
- package/dist/cjs/scroll-restoration.cjs +5 -4
- package/dist/cjs/scroll-restoration.cjs.map +1 -1
- package/dist/cjs/scroll-restoration.d.cts +2 -1
- package/dist/esm/scroll-restoration.d.ts +2 -1
- package/dist/esm/scroll-restoration.js +5 -4
- package/dist/esm/scroll-restoration.js.map +1 -1
- package/dist/source/scroll-restoration.d.ts +2 -1
- package/dist/source/scroll-restoration.jsx +4 -3
- package/dist/source/scroll-restoration.jsx.map +1 -1
- package/package.json +3 -3
- package/src/scroll-restoration.tsx +5 -1
|
@@ -28,7 +28,8 @@ const scrollRestorationCache = sessionsStorage ? (() => {
|
|
|
28
28
|
// This setter is simply to make sure that we set the sessionStorage right
|
|
29
29
|
// after the state is updated. It doesn't necessarily need to be a functional
|
|
30
30
|
// update.
|
|
31
|
-
set: (updater) => (scrollRestorationCache.state =
|
|
31
|
+
set: (updater) => (scrollRestorationCache.state = // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
|
32
|
+
routerCore.functionalUpdate(updater, scrollRestorationCache.state) || scrollRestorationCache.state, window.sessionStorage.setItem(storageKey, JSON.stringify(scrollRestorationCache.state)))
|
|
32
33
|
};
|
|
33
34
|
})() : void 0;
|
|
34
35
|
const defaultGetScrollRestorationKey = (location) => {
|
|
@@ -44,7 +45,7 @@ function getCssSelector(el) {
|
|
|
44
45
|
return `${path.join(" > ")}`.toLowerCase();
|
|
45
46
|
}
|
|
46
47
|
let ignoreScroll = false;
|
|
47
|
-
function restoreScroll(storageKey2, key, behavior, shouldScrollRestoration, scrollToTopSelectors) {
|
|
48
|
+
function restoreScroll(routerHistory, storageKey2, key, behavior, shouldScrollRestoration, scrollToTopSelectors) {
|
|
48
49
|
var _a;
|
|
49
50
|
let byKey;
|
|
50
51
|
try {
|
|
@@ -76,7 +77,7 @@ function restoreScroll(storageKey2, key, behavior, shouldScrollRestoration, scro
|
|
|
76
77
|
}
|
|
77
78
|
return;
|
|
78
79
|
}
|
|
79
|
-
const hash =
|
|
80
|
+
const hash = routerHistory.location.hash.split("#")[1];
|
|
80
81
|
if (hash) {
|
|
81
82
|
const hashScrollIntoViewOptions = (window.history.state || {}).__hashScrollIntoViewOptions ?? true;
|
|
82
83
|
if (hashScrollIntoViewOptions) {
|
|
@@ -153,7 +154,7 @@ function setupScrollRestoration(router, force) {
|
|
|
153
154
|
router.resetNextScroll = true;
|
|
154
155
|
return;
|
|
155
156
|
}
|
|
156
|
-
restoreScroll(storageKey, cacheKey, router.options.scrollRestorationBehavior, router.isScrollRestoring, router.options.scrollToTopSelectors);
|
|
157
|
+
restoreScroll(router.history, storageKey, cacheKey, router.options.scrollRestorationBehavior, router.isScrollRestoring, router.options.scrollToTopSelectors);
|
|
157
158
|
if (router.isScrollRestoring) {
|
|
158
159
|
scrollRestorationCache.set((state) => {
|
|
159
160
|
state[cacheKey] = state[cacheKey] || {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"scroll-restoration.cjs","sources":["../../src/scroll-restoration.tsx"],"sourcesContent":["import { functionalUpdate } from '@tanstack/router-core'\nimport { useRouter } from './useRouter'\nimport { ScriptOnce } from './ScriptOnce'\n\nimport type {\n AnyRouter,\n NonNullableUpdater,\n ParsedLocation,\n} from '@tanstack/router-core'\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\nexport const storageKey = 'tsr-scroll-restoration-v1_3'\nlet sessionsStorage = false\ntry {\n sessionsStorage =\n typeof window !== 'undefined' && typeof window.sessionStorage === 'object'\n} catch {}\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}\nexport const scrollRestorationCache: ScrollRestorationCache = sessionsStorage\n ? (() => {\n const state: ScrollRestorationByKey =\n JSON.parse(window.sessionStorage.getItem(storageKey) || 'null') || {}\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 (scrollRestorationCache.state =\n functionalUpdate(updater, scrollRestorationCache.state) ||\n scrollRestorationCache.state),\n window.sessionStorage.setItem(\n storageKey,\n JSON.stringify(scrollRestorationCache.state),\n )\n ),\n }\n })()\n : (undefined as any)\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\nexport const defaultGetScrollRestorationKey = (location: ParsedLocation) => {\n return location.state.key! || location.href\n}\n\nexport function getCssSelector(el: any): string {\n const path = []\n let parent\n while ((parent = el.parentNode)) {\n path.unshift(\n `${el.tagName}:nth-child(${([].indexOf as any).call(parent.children, el) + 1})`,\n )\n el = parent\n }\n return `${path.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: string,\n key?: string,\n behavior?: ScrollToOptions['behavior'],\n shouldScrollRestoration?: boolean,\n scrollToTopSelectors?: Array<string>,\n) {\n let byKey: ScrollRestorationByKey\n\n try {\n byKey = JSON.parse(sessionStorage.getItem(storageKey) || '{}')\n } catch (error: any) {\n console.error(error)\n return\n }\n\n const resolvedKey = key || window.history.state?.key\n const elementEntries = byKey[resolvedKey]\n\n //\n ignoreScroll = true\n\n //\n ;(() => {\n // If we have a cached entry for this location state,\n // we always need to prefer that over the hash scroll.\n if (shouldScrollRestoration && elementEntries) {\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 return\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 = window.location.hash.split('#')[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 // 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 ;[\n 'window',\n ...(scrollToTopSelectors?.filter((d) => d !== 'window') ?? []),\n ].forEach((selector) => {\n const element =\n selector === 'window' ? window : document.querySelector(selector)\n if (element) {\n element.scrollTo({\n top: 0,\n left: 0,\n behavior,\n })\n }\n })\n })()\n\n //\n ignoreScroll = false\n}\n\nexport function setupScrollRestoration(router: AnyRouter, force?: boolean) {\n const shouldScrollRestoration =\n force ?? router.options.scrollRestoration ?? false\n\n if (shouldScrollRestoration) {\n router.isScrollRestoring = true\n }\n\n if (typeof document === 'undefined' || router.isScrollRestorationSetup) {\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.state.location),\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.state.location)\n\n scrollRestorationCache.set((state) => {\n const keyEntry = (state[restoreKey] =\n state[restoreKey] || ({} as ScrollRestorationByElement))\n\n const elementEntry = (keyEntry[elementSelector] =\n keyEntry[elementSelector] || ({} 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\n restoreScroll(\n storageKey,\n cacheKey,\n router.options.scrollRestorationBehavior,\n router.isScrollRestoring,\n router.options.scrollToTopSelectors,\n )\n\n if (router.isScrollRestoring) {\n // Mark the location as having been seen\n scrollRestorationCache.set((state) => {\n state[cacheKey] = state[cacheKey] || ({} as ScrollRestorationByElement)\n\n return state\n })\n }\n })\n}\n\nexport function ScrollRestoration() {\n const router = useRouter()\n const getKey =\n router.options.getScrollRestorationKey || defaultGetScrollRestorationKey\n const userKey = getKey(router.latestLocation)\n const resolvedKey =\n userKey !== defaultGetScrollRestorationKey(router.latestLocation)\n ? userKey\n : null\n\n if (!router.isScrollRestoring || !router.isServer) {\n return null\n }\n\n return (\n <ScriptOnce\n children={`(${restoreScroll.toString()})(${JSON.stringify(storageKey)},${JSON.stringify(resolvedKey)}, undefined, true)`}\n log={false}\n />\n )\n}\n"],"names":["storageKey","sessionsStorage","window","sessionStorage","throttle","fn","wait","timeout","args","setTimeout","scrollRestorationCache","state","JSON","parse","getItem","set","updater","functionalUpdate","setItem","stringify","undefined","defaultGetScrollRestorationKey","location","key","href","getCssSelector","el","path","parent","parentNode","unshift","tagName","indexOf","call","children","join","toLowerCase","ignoreScroll","restoreScroll","behavior","shouldScrollRestoration","scrollToTopSelectors","byKey","error","console","resolvedKey","history","elementEntries","elementSelector","entry","scrollTo","top","scrollY","left","scrollX","element","document","querySelector","scrollLeft","scrollTop","hash","split","hashScrollIntoViewOptions","__hashScrollIntoViewOptions","getElementById","scrollIntoView","filter","d","forEach","selector","setupScrollRestoration","router","force","options","scrollRestoration","isScrollRestoring","isScrollRestorationSetup","getKey","getScrollRestorationKey","onScroll","event","target","attrId","getAttribute","restoreKey","keyEntry","elementEntry","addEventListener","subscribe","cacheKey","toLocation","resetNextScroll","scrollRestorationBehavior","ScrollRestoration","useRouter","userKey","latestLocation","isServer","_$createComponent","ScriptOnce","toString","log"],"mappings":";;;;;;AAyBO,MAAMA,aAAa;AAC1B,IAAIC,kBAAkB;AACtB,IAAI;AACFA,oBACE,OAAOC,WAAW,eAAe,OAAOA,OAAOC,mBAAmB;AACtE,QAAQ;AAAC;AACT,MAAMC,WAAWA,CAACC,IAAmCC,SAAiB;AAChEC,MAAAA;AACJ,SAAO,IAAIC,SAAqB;AAC9B,QAAI,CAACD,SAAS;AACZA,gBAAUE,WAAW,MAAM;AACzBJ,WAAG,GAAGG,IAAI;AACA,kBAAA;AAAA,SACTF,IAAI;AAAA,IAAA;AAAA,EAEX;AACF;AACaI,MAAAA,yBAAiDT,mBACzD,MAAM;AACCU,QAAAA,QACJC,KAAKC,MAAMX,OAAOC,eAAeW,QAAQd,UAAU,KAAK,MAAM,KAAK,CAAC;AAE/D,SAAA;AAAA,IACLW;AAAAA;AAAAA;AAAAA;AAAAA,IAIAI,KAAMC,CACHN,aAAAA,uBAAuBC,QACtBM,WAAAA,iBAAiBD,SAASN,uBAAuBC,KAAK,KACtDD,uBAAuBC,OACzBT,OAAOC,eAAee,QACpBlB,YACAY,KAAKO,UAAUT,uBAAuBC,KAAK,CAC7C;AAAA,EAEJ;AACF,OACCS;AAQQC,MAAAA,iCAAiCA,CAACC,aAA6B;AACnEA,SAAAA,SAASX,MAAMY,OAAQD,SAASE;AACzC;AAEO,SAASC,eAAeC,IAAiB;AAC9C,QAAMC,OAAO,CAAE;AACXC,MAAAA;AACIA,SAAAA,SAASF,GAAGG,YAAa;AAC/BF,SAAKG,QACH,GAAGJ,GAAGK,OAAO,cAAe,CAAE,EAACC,QAAgBC,KAAKL,OAAOM,UAAUR,EAAE,IAAI,CAAC,GAC9E;AACKE,SAAAA;AAAAA,EAAAA;AAEP,SAAO,GAAGD,KAAKQ,KAAK,KAAK,CAAC,GAAGC,YAAY;AAC3C;AAEA,IAAIC,eAAe;AAMZ,SAASC,cACdtC,aACAuB,KACAgB,UACAC,yBACAC,sBACA;;AACIC,MAAAA;AAEA,MAAA;AACFA,YAAQ9B,KAAKC,MAAMV,eAAeW,QAAQd,WAAU,KAAK,IAAI;AAAA,WACtD2C,OAAY;AACnBC,YAAQD,MAAMA,KAAK;AACnB;AAAA,EAAA;AAGF,QAAME,cAActB,SAAOrB,YAAO4C,QAAQnC,UAAfT,mBAAsBqB;AAC3CwB,QAAAA,iBAAiBL,MAAMG,WAAW;AAGzB,iBAAA;AAGd,GAAC,MAAM;AAGN,QAAIL,2BAA2BO,gBAAgB;AAC7C,iBAAWC,mBAAmBD,gBAAgB;AACtCE,cAAAA,QAAQF,eAAeC,eAAe;AAC5C,YAAIA,oBAAoB,UAAU;AAChC9C,iBAAOgD,SAAS;AAAA,YACdC,KAAKF,MAAMG;AAAAA,YACXC,MAAMJ,MAAMK;AAAAA,YACZf;AAAAA,UAAAA,CACD;AAAA,mBACQS,iBAAiB;AACpBO,gBAAAA,UAAUC,SAASC,cAAcT,eAAe;AACtD,cAAIO,SAAS;AACXA,oBAAQG,aAAaT,MAAMK;AAC3BC,oBAAQI,YAAYV,MAAMG;AAAAA,UAAAA;AAAAA,QAC5B;AAAA,MACF;AAGF;AAAA,IAAA;AAOF,UAAMQ,OAAO1D,OAAOoB,SAASsC,KAAKC,MAAM,GAAG,EAAE,CAAC;AAE9C,QAAID,MAAM;AACR,YAAME,6BACH5D,OAAO4C,QAAQnC,SAAS,CAAA,GAAIoD,+BAA+B;AAE9D,UAAID,2BAA2B;AACvBpC,cAAAA,KAAK8B,SAASQ,eAAeJ,IAAI;AACvC,YAAIlC,IAAI;AACNA,aAAGuC,eAAeH,yBAAyB;AAAA,QAAA;AAAA,MAC7C;AAGF;AAAA,IAAA;AAKD,KACC,UACA,IAAIrB,6DAAsByB,OAAQC,CAAMA,MAAAA,MAAM,cAAa,CAAG,CAAA,EAC9DC,QAASC,CAAa,aAAA;AACtB,YAAMd,UACJc,aAAa,WAAWnE,SAASsD,SAASC,cAAcY,QAAQ;AAClE,UAAId,SAAS;AACXA,gBAAQL,SAAS;AAAA,UACfC,KAAK;AAAA,UACLE,MAAM;AAAA,UACNd;AAAAA,QAAAA,CACD;AAAA,MAAA;AAAA,IACH,CACD;AAAA,EAAA,GACA;AAGY,iBAAA;AACjB;AAEgB+B,SAAAA,uBAAuBC,QAAmBC,OAAiB;AACzE,QAAMhC,0BACJgC,SAASD,OAAOE,QAAQC,qBAAqB;AAE/C,MAAIlC,yBAAyB;AAC3B+B,WAAOI,oBAAoB;AAAA,EAAA;AAG7B,MAAI,OAAOnB,aAAa,eAAee,OAAOK,0BAA0B;AACtE;AAAA,EAAA;AAGFL,SAAOK,2BAA2B;AAGnB,iBAAA;AAETC,QAAAA,SACJN,OAAOE,QAAQK,2BAA2BzD;AAE5CnB,SAAO4C,QAAQ4B,oBAAoB;AAuC7BK,QAAAA,WAAWA,CAACC,UAAiB;AAG7B3C,QAAAA,gBAAgB,CAACkC,OAAOI,mBAAmB;AAC7C;AAAA,IAAA;AAGF,QAAI3B,kBAAkB;AAEtB,QAAIgC,MAAMC,WAAWzB,YAAYwB,MAAMC,WAAW/E,QAAQ;AACtC,wBAAA;AAAA,IAAA,OACb;AACL,YAAMgF,SAAUF,MAAMC,OAAmBE,aACvC,4BACF;AAEA,UAAID,QAAQ;AACVlC,0BAAkB,gCAAgCkC,MAAM;AAAA,MAAA,OACnD;AACazD,0BAAAA,eAAeuD,MAAMC,MAAM;AAAA,MAAA;AAAA,IAC/C;AAGF,UAAMG,aAAaP,OAAON,OAAO5D,MAAMW,QAAQ;AAE/CZ,2BAAuBK,IAAKJ,CAAU,UAAA;AACpC,YAAM0E,WAAY1E,MAAMyE,UAAU,IAChCzE,MAAMyE,UAAU,KAAM,CAAC;AAEzB,YAAME,eAAgBD,SAASrC,eAAe,IAC5CqC,SAASrC,eAAe,KAAM,CAAC;AAEjC,UAAIA,oBAAoB,UAAU;AACnBM,qBAAAA,UAAUpD,OAAOoD,WAAW;AAC5BF,qBAAAA,UAAUlD,OAAOkD,WAAW;AAAA,iBAChCJ,iBAAiB;AACpBO,cAAAA,UAAUC,SAASC,cAAcT,eAAe;AACtD,YAAIO,SAAS;AACED,uBAAAA,UAAUC,QAAQG,cAAc;AAChCN,uBAAAA,UAAUG,QAAQI,aAAa;AAAA,QAAA;AAAA,MAC9C;AAGKhD,aAAAA;AAAAA,IAAAA,CACR;AAAA,EACH;AAGI,MAAA,OAAO6C,aAAa,aAAa;AACnCA,aAAS+B,iBAAiB,UAAUnF,SAAS2E,UAAU,GAAG,GAAG,IAAI;AAAA,EAAA;AAG5DS,SAAAA,UAAU,cAAeR,CAAU,UAAA;AAGlCS,UAAAA,WAAWZ,OAAOG,MAAMU,UAAU;AAIpC,QAAA,CAACnB,OAAOoB,iBAAiB;AAC3BpB,aAAOoB,kBAAkB;AACzB;AAAA,IAAA;AAIA3F,kBAAAA,YACAyF,UACAlB,OAAOE,QAAQmB,2BACfrB,OAAOI,mBACPJ,OAAOE,QAAQhC,oBACjB;AAEA,QAAI8B,OAAOI,mBAAmB;AAE5BjE,6BAAuBK,IAAKJ,CAAU,UAAA;AACpCA,cAAM8E,QAAQ,IAAI9E,MAAM8E,QAAQ,KAAM,CAAC;AAEhC9E,eAAAA;AAAAA,MAAAA,CACR;AAAA,IAAA;AAAA,EACH,CACD;AACH;AAEO,SAASkF,oBAAoB;AAClC,QAAMtB,SAASuB,UAAAA,UAAU;AACnBjB,QAAAA,SACJN,OAAOE,QAAQK,2BAA2BzD;AACtC0E,QAAAA,UAAUlB,OAAON,OAAOyB,cAAc;AAC5C,QAAMnD,cACJkD,YAAY1E,+BAA+BkD,OAAOyB,cAAc,IAC5DD,UACA;AAEN,MAAI,CAACxB,OAAOI,qBAAqB,CAACJ,OAAO0B,UAAU;AAC1C,WAAA;AAAA,EAAA;AAGT,SAAAC,IAAAA,gBACGC,WAAAA,YAAU;AAAA,IAAA,IACTjE,WAAQ;AAAA,aAAE,IAAII,cAAc8D,SAAS,CAAC,KAAKxF,KAAKO,UAAUnB,UAAU,CAAC,IAAIY,KAAKO,UAAU0B,WAAW,CAAC;AAAA,IAAoB;AAAA,IACxHwD,KAAK;AAAA,EAAA,CAAK;AAGhB;;;;;;;;"}
|
|
1
|
+
{"version":3,"file":"scroll-restoration.cjs","sources":["../../src/scroll-restoration.tsx"],"sourcesContent":["import { functionalUpdate } from '@tanstack/router-core'\nimport { useRouter } from './useRouter'\nimport { ScriptOnce } from './ScriptOnce'\n\nimport type {\n AnyRouter,\n NonNullableUpdater,\n ParsedLocation,\n} from '@tanstack/router-core'\nimport type { RouterHistory } 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\nexport const storageKey = 'tsr-scroll-restoration-v1_3'\nlet sessionsStorage = false\ntry {\n sessionsStorage =\n typeof window !== 'undefined' && typeof window.sessionStorage === 'object'\n} catch {}\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}\nexport const scrollRestorationCache: ScrollRestorationCache = sessionsStorage\n ? (() => {\n const state: ScrollRestorationByKey =\n JSON.parse(window.sessionStorage.getItem(storageKey) || 'null') || {}\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 (scrollRestorationCache.state =\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n functionalUpdate(updater, scrollRestorationCache.state) ||\n scrollRestorationCache.state),\n window.sessionStorage.setItem(\n storageKey,\n JSON.stringify(scrollRestorationCache.state),\n )\n ),\n }\n })()\n : (undefined as any)\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\nexport const defaultGetScrollRestorationKey = (location: ParsedLocation) => {\n return location.state.key! || location.href\n}\n\nexport function getCssSelector(el: any): string {\n const path = []\n let parent\n while ((parent = el.parentNode)) {\n path.unshift(\n `${el.tagName}:nth-child(${([].indexOf as any).call(parent.children, el) + 1})`,\n )\n el = parent\n }\n return `${path.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 routerHistory: RouterHistory,\n storageKey: string,\n key?: string,\n behavior?: ScrollToOptions['behavior'],\n shouldScrollRestoration?: boolean,\n scrollToTopSelectors?: Array<string>,\n) {\n let byKey: ScrollRestorationByKey\n\n try {\n byKey = JSON.parse(sessionStorage.getItem(storageKey) || '{}')\n } catch (error: any) {\n console.error(error)\n return\n }\n\n const resolvedKey = key || window.history.state?.key\n const elementEntries = byKey[resolvedKey]\n\n //\n ignoreScroll = true\n\n //\n ;(() => {\n // If we have a cached entry for this location state,\n // we always need to prefer that over the hash scroll.\n if (shouldScrollRestoration && elementEntries) {\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 return\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 = routerHistory.location.hash.split('#')[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 // 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 ;[\n 'window',\n ...(scrollToTopSelectors?.filter((d) => d !== 'window') ?? []),\n ].forEach((selector) => {\n const element =\n selector === 'window' ? window : document.querySelector(selector)\n if (element) {\n element.scrollTo({\n top: 0,\n left: 0,\n behavior,\n })\n }\n })\n })()\n\n //\n ignoreScroll = false\n}\n\nexport function setupScrollRestoration(router: AnyRouter, force?: boolean) {\n const shouldScrollRestoration =\n force ?? router.options.scrollRestoration ?? false\n\n if (shouldScrollRestoration) {\n router.isScrollRestoring = true\n }\n\n if (typeof document === 'undefined' || router.isScrollRestorationSetup) {\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.state.location),\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.state.location)\n\n scrollRestorationCache.set((state) => {\n const keyEntry = (state[restoreKey] =\n state[restoreKey] || ({} as ScrollRestorationByElement))\n\n const elementEntry = (keyEntry[elementSelector] =\n keyEntry[elementSelector] || ({} 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\n restoreScroll(\n router.history,\n storageKey,\n cacheKey,\n router.options.scrollRestorationBehavior,\n router.isScrollRestoring,\n router.options.scrollToTopSelectors,\n )\n\n if (router.isScrollRestoring) {\n // Mark the location as having been seen\n scrollRestorationCache.set((state) => {\n state[cacheKey] = state[cacheKey] || ({} as ScrollRestorationByElement)\n\n return state\n })\n }\n })\n}\n\nexport function ScrollRestoration() {\n const router = useRouter()\n const getKey =\n router.options.getScrollRestorationKey || defaultGetScrollRestorationKey\n const userKey = getKey(router.latestLocation)\n const resolvedKey =\n userKey !== defaultGetScrollRestorationKey(router.latestLocation)\n ? userKey\n : null\n\n if (!router.isScrollRestoring || !router.isServer) {\n return null\n }\n\n return (\n <ScriptOnce\n children={`(${restoreScroll.toString()})(${JSON.stringify(storageKey)},${JSON.stringify(resolvedKey)}, undefined, true)`}\n log={false}\n />\n )\n}\n"],"names":["storageKey","sessionsStorage","window","sessionStorage","throttle","fn","wait","timeout","args","setTimeout","scrollRestorationCache","state","JSON","parse","getItem","set","updater","functionalUpdate","setItem","stringify","undefined","defaultGetScrollRestorationKey","location","key","href","getCssSelector","el","path","parent","parentNode","unshift","tagName","indexOf","call","children","join","toLowerCase","ignoreScroll","restoreScroll","routerHistory","behavior","shouldScrollRestoration","scrollToTopSelectors","byKey","error","console","resolvedKey","history","elementEntries","elementSelector","entry","scrollTo","top","scrollY","left","scrollX","element","document","querySelector","scrollLeft","scrollTop","hash","split","hashScrollIntoViewOptions","__hashScrollIntoViewOptions","getElementById","scrollIntoView","filter","d","forEach","selector","setupScrollRestoration","router","force","options","scrollRestoration","isScrollRestoring","isScrollRestorationSetup","getKey","getScrollRestorationKey","onScroll","event","target","attrId","getAttribute","restoreKey","keyEntry","elementEntry","addEventListener","subscribe","cacheKey","toLocation","resetNextScroll","scrollRestorationBehavior","ScrollRestoration","useRouter","userKey","latestLocation","isServer","_$createComponent","ScriptOnce","toString","log"],"mappings":";;;;;;AA0BO,MAAMA,aAAa;AAC1B,IAAIC,kBAAkB;AACtB,IAAI;AACFA,oBACE,OAAOC,WAAW,eAAe,OAAOA,OAAOC,mBAAmB;AACtE,QAAQ;AAAC;AACT,MAAMC,WAAWA,CAACC,IAAmCC,SAAiB;AAChEC,MAAAA;AACJ,SAAO,IAAIC,SAAqB;AAC9B,QAAI,CAACD,SAAS;AACZA,gBAAUE,WAAW,MAAM;AACzBJ,WAAG,GAAGG,IAAI;AACA,kBAAA;AAAA,SACTF,IAAI;AAAA,IAAA;AAAA,EAEX;AACF;AACaI,MAAAA,yBAAiDT,mBACzD,MAAM;AACCU,QAAAA,QACJC,KAAKC,MAAMX,OAAOC,eAAeW,QAAQd,UAAU,KAAK,MAAM,KAAK,CAAC;AAE/D,SAAA;AAAA,IACLW;AAAAA;AAAAA;AAAAA;AAAAA,IAIAI,KAAMC,cACHN,uBAAuBC;AAAAA,IAEtBM,WAAiBD,iBAAAA,SAASN,uBAAuBC,KAAK,KACtDD,uBAAuBC,OACzBT,OAAOC,eAAee,QACpBlB,YACAY,KAAKO,UAAUT,uBAAuBC,KAAK,CAC7C;AAAA,EAEJ;AACF,OACCS;AAQQC,MAAAA,iCAAiCA,CAACC,aAA6B;AACnEA,SAAAA,SAASX,MAAMY,OAAQD,SAASE;AACzC;AAEO,SAASC,eAAeC,IAAiB;AAC9C,QAAMC,OAAO,CAAE;AACXC,MAAAA;AACIA,SAAAA,SAASF,GAAGG,YAAa;AAC/BF,SAAKG,QACH,GAAGJ,GAAGK,OAAO,cAAe,CAAE,EAACC,QAAgBC,KAAKL,OAAOM,UAAUR,EAAE,IAAI,CAAC,GAC9E;AACKE,SAAAA;AAAAA,EAAAA;AAEP,SAAO,GAAGD,KAAKQ,KAAK,KAAK,CAAC,GAAGC,YAAY;AAC3C;AAEA,IAAIC,eAAe;AAMZ,SAASC,cACdC,eACAvC,aACAuB,KACAiB,UACAC,yBACAC,sBACA;;AACIC,MAAAA;AAEA,MAAA;AACFA,YAAQ/B,KAAKC,MAAMV,eAAeW,QAAQd,WAAU,KAAK,IAAI;AAAA,WACtD4C,OAAY;AACnBC,YAAQD,MAAMA,KAAK;AACnB;AAAA,EAAA;AAGF,QAAME,cAAcvB,SAAOrB,YAAO6C,QAAQpC,UAAfT,mBAAsBqB;AAC3CyB,QAAAA,iBAAiBL,MAAMG,WAAW;AAGzB,iBAAA;AAGd,GAAC,MAAM;AAGN,QAAIL,2BAA2BO,gBAAgB;AAC7C,iBAAWC,mBAAmBD,gBAAgB;AACtCE,cAAAA,QAAQF,eAAeC,eAAe;AAC5C,YAAIA,oBAAoB,UAAU;AAChC/C,iBAAOiD,SAAS;AAAA,YACdC,KAAKF,MAAMG;AAAAA,YACXC,MAAMJ,MAAMK;AAAAA,YACZf;AAAAA,UAAAA,CACD;AAAA,mBACQS,iBAAiB;AACpBO,gBAAAA,UAAUC,SAASC,cAAcT,eAAe;AACtD,cAAIO,SAAS;AACXA,oBAAQG,aAAaT,MAAMK;AAC3BC,oBAAQI,YAAYV,MAAMG;AAAAA,UAAAA;AAAAA,QAC5B;AAAA,MACF;AAGF;AAAA,IAAA;AAOF,UAAMQ,OAAOtB,cAAcjB,SAASuC,KAAKC,MAAM,GAAG,EAAE,CAAC;AAErD,QAAID,MAAM;AACR,YAAME,6BACH7D,OAAO6C,QAAQpC,SAAS,CAAA,GAAIqD,+BAA+B;AAE9D,UAAID,2BAA2B;AACvBrC,cAAAA,KAAK+B,SAASQ,eAAeJ,IAAI;AACvC,YAAInC,IAAI;AACNA,aAAGwC,eAAeH,yBAAyB;AAAA,QAAA;AAAA,MAC7C;AAGF;AAAA,IAAA;AAKD,KACC,UACA,IAAIrB,6DAAsByB,OAAQC,CAAMA,MAAAA,MAAM,cAAa,CAAG,CAAA,EAC9DC,QAASC,CAAa,aAAA;AACtB,YAAMd,UACJc,aAAa,WAAWpE,SAASuD,SAASC,cAAcY,QAAQ;AAClE,UAAId,SAAS;AACXA,gBAAQL,SAAS;AAAA,UACfC,KAAK;AAAA,UACLE,MAAM;AAAA,UACNd;AAAAA,QAAAA,CACD;AAAA,MAAA;AAAA,IACH,CACD;AAAA,EAAA,GACA;AAGY,iBAAA;AACjB;AAEgB+B,SAAAA,uBAAuBC,QAAmBC,OAAiB;AACzE,QAAMhC,0BACJgC,SAASD,OAAOE,QAAQC,qBAAqB;AAE/C,MAAIlC,yBAAyB;AAC3B+B,WAAOI,oBAAoB;AAAA,EAAA;AAG7B,MAAI,OAAOnB,aAAa,eAAee,OAAOK,0BAA0B;AACtE;AAAA,EAAA;AAGFL,SAAOK,2BAA2B;AAGnB,iBAAA;AAETC,QAAAA,SACJN,OAAOE,QAAQK,2BAA2B1D;AAE5CnB,SAAO6C,QAAQ4B,oBAAoB;AAuC7BK,QAAAA,WAAWA,CAACC,UAAiB;AAG7B5C,QAAAA,gBAAgB,CAACmC,OAAOI,mBAAmB;AAC7C;AAAA,IAAA;AAGF,QAAI3B,kBAAkB;AAEtB,QAAIgC,MAAMC,WAAWzB,YAAYwB,MAAMC,WAAWhF,QAAQ;AACtC,wBAAA;AAAA,IAAA,OACb;AACL,YAAMiF,SAAUF,MAAMC,OAAmBE,aACvC,4BACF;AAEA,UAAID,QAAQ;AACVlC,0BAAkB,gCAAgCkC,MAAM;AAAA,MAAA,OACnD;AACa1D,0BAAAA,eAAewD,MAAMC,MAAM;AAAA,MAAA;AAAA,IAC/C;AAGF,UAAMG,aAAaP,OAAON,OAAO7D,MAAMW,QAAQ;AAE/CZ,2BAAuBK,IAAKJ,CAAU,UAAA;AACpC,YAAM2E,WAAY3E,MAAM0E,UAAU,IAChC1E,MAAM0E,UAAU,KAAM,CAAC;AAEzB,YAAME,eAAgBD,SAASrC,eAAe,IAC5CqC,SAASrC,eAAe,KAAM,CAAC;AAEjC,UAAIA,oBAAoB,UAAU;AACnBM,qBAAAA,UAAUrD,OAAOqD,WAAW;AAC5BF,qBAAAA,UAAUnD,OAAOmD,WAAW;AAAA,iBAChCJ,iBAAiB;AACpBO,cAAAA,UAAUC,SAASC,cAAcT,eAAe;AACtD,YAAIO,SAAS;AACED,uBAAAA,UAAUC,QAAQG,cAAc;AAChCN,uBAAAA,UAAUG,QAAQI,aAAa;AAAA,QAAA;AAAA,MAC9C;AAGKjD,aAAAA;AAAAA,IAAAA,CACR;AAAA,EACH;AAGI,MAAA,OAAO8C,aAAa,aAAa;AACnCA,aAAS+B,iBAAiB,UAAUpF,SAAS4E,UAAU,GAAG,GAAG,IAAI;AAAA,EAAA;AAG5DS,SAAAA,UAAU,cAAeR,CAAU,UAAA;AAGlCS,UAAAA,WAAWZ,OAAOG,MAAMU,UAAU;AAIpC,QAAA,CAACnB,OAAOoB,iBAAiB;AAC3BpB,aAAOoB,kBAAkB;AACzB;AAAA,IAAA;AAIApB,kBAAAA,OAAOzB,SACP/C,YACA0F,UACAlB,OAAOE,QAAQmB,2BACfrB,OAAOI,mBACPJ,OAAOE,QAAQhC,oBACjB;AAEA,QAAI8B,OAAOI,mBAAmB;AAE5BlE,6BAAuBK,IAAKJ,CAAU,UAAA;AACpCA,cAAM+E,QAAQ,IAAI/E,MAAM+E,QAAQ,KAAM,CAAC;AAEhC/E,eAAAA;AAAAA,MAAAA,CACR;AAAA,IAAA;AAAA,EACH,CACD;AACH;AAEO,SAASmF,oBAAoB;AAClC,QAAMtB,SAASuB,UAAAA,UAAU;AACnBjB,QAAAA,SACJN,OAAOE,QAAQK,2BAA2B1D;AACtC2E,QAAAA,UAAUlB,OAAON,OAAOyB,cAAc;AAC5C,QAAMnD,cACJkD,YAAY3E,+BAA+BmD,OAAOyB,cAAc,IAC5DD,UACA;AAEN,MAAI,CAACxB,OAAOI,qBAAqB,CAACJ,OAAO0B,UAAU;AAC1C,WAAA;AAAA,EAAA;AAGT,SAAAC,IAAAA,gBACGC,WAAAA,YAAU;AAAA,IAAA,IACTlE,WAAQ;AAAA,aAAE,IAAII,cAAc+D,SAAS,CAAC,KAAKzF,KAAKO,UAAUnB,UAAU,CAAC,IAAIY,KAAKO,UAAU2B,WAAW,CAAC;AAAA,IAAoB;AAAA,IACxHwD,KAAK;AAAA,EAAA,CAAK;AAGhB;;;;;;;;"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { AnyRouter, NonNullableUpdater, ParsedLocation } from '@tanstack/router-core';
|
|
2
|
+
import { RouterHistory } from '@tanstack/history';
|
|
2
3
|
export type ScrollRestorationEntry = {
|
|
3
4
|
scrollX: number;
|
|
4
5
|
scrollY: number;
|
|
@@ -23,6 +24,6 @@ export declare const scrollRestorationCache: ScrollRestorationCache;
|
|
|
23
24
|
*/
|
|
24
25
|
export declare const defaultGetScrollRestorationKey: (location: ParsedLocation) => string;
|
|
25
26
|
export declare function getCssSelector(el: any): string;
|
|
26
|
-
export declare function restoreScroll(storageKey: string, key?: string, behavior?: ScrollToOptions['behavior'], shouldScrollRestoration?: boolean, scrollToTopSelectors?: Array<string>): void;
|
|
27
|
+
export declare function restoreScroll(routerHistory: RouterHistory, storageKey: string, key?: string, behavior?: ScrollToOptions['behavior'], shouldScrollRestoration?: boolean, scrollToTopSelectors?: Array<string>): void;
|
|
27
28
|
export declare function setupScrollRestoration(router: AnyRouter, force?: boolean): void;
|
|
28
29
|
export declare function ScrollRestoration(): import("solid-js").JSX.Element;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { AnyRouter, NonNullableUpdater, ParsedLocation } from '@tanstack/router-core';
|
|
2
|
+
import { RouterHistory } from '@tanstack/history';
|
|
2
3
|
export type ScrollRestorationEntry = {
|
|
3
4
|
scrollX: number;
|
|
4
5
|
scrollY: number;
|
|
@@ -23,6 +24,6 @@ export declare const scrollRestorationCache: ScrollRestorationCache;
|
|
|
23
24
|
*/
|
|
24
25
|
export declare const defaultGetScrollRestorationKey: (location: ParsedLocation) => string;
|
|
25
26
|
export declare function getCssSelector(el: any): string;
|
|
26
|
-
export declare function restoreScroll(storageKey: string, key?: string, behavior?: ScrollToOptions['behavior'], shouldScrollRestoration?: boolean, scrollToTopSelectors?: Array<string>): void;
|
|
27
|
+
export declare function restoreScroll(routerHistory: RouterHistory, storageKey: string, key?: string, behavior?: ScrollToOptions['behavior'], shouldScrollRestoration?: boolean, scrollToTopSelectors?: Array<string>): void;
|
|
27
28
|
export declare function setupScrollRestoration(router: AnyRouter, force?: boolean): void;
|
|
28
29
|
export declare function ScrollRestoration(): import("solid-js").JSX.Element;
|
|
@@ -26,7 +26,8 @@ const scrollRestorationCache = sessionsStorage ? (() => {
|
|
|
26
26
|
// This setter is simply to make sure that we set the sessionStorage right
|
|
27
27
|
// after the state is updated. It doesn't necessarily need to be a functional
|
|
28
28
|
// update.
|
|
29
|
-
set: (updater) => (scrollRestorationCache.state =
|
|
29
|
+
set: (updater) => (scrollRestorationCache.state = // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
|
30
|
+
functionalUpdate(updater, scrollRestorationCache.state) || scrollRestorationCache.state, window.sessionStorage.setItem(storageKey, JSON.stringify(scrollRestorationCache.state)))
|
|
30
31
|
};
|
|
31
32
|
})() : void 0;
|
|
32
33
|
const defaultGetScrollRestorationKey = (location) => {
|
|
@@ -42,7 +43,7 @@ function getCssSelector(el) {
|
|
|
42
43
|
return `${path.join(" > ")}`.toLowerCase();
|
|
43
44
|
}
|
|
44
45
|
let ignoreScroll = false;
|
|
45
|
-
function restoreScroll(storageKey2, key, behavior, shouldScrollRestoration, scrollToTopSelectors) {
|
|
46
|
+
function restoreScroll(routerHistory, storageKey2, key, behavior, shouldScrollRestoration, scrollToTopSelectors) {
|
|
46
47
|
var _a;
|
|
47
48
|
let byKey;
|
|
48
49
|
try {
|
|
@@ -74,7 +75,7 @@ function restoreScroll(storageKey2, key, behavior, shouldScrollRestoration, scro
|
|
|
74
75
|
}
|
|
75
76
|
return;
|
|
76
77
|
}
|
|
77
|
-
const hash =
|
|
78
|
+
const hash = routerHistory.location.hash.split("#")[1];
|
|
78
79
|
if (hash) {
|
|
79
80
|
const hashScrollIntoViewOptions = (window.history.state || {}).__hashScrollIntoViewOptions ?? true;
|
|
80
81
|
if (hashScrollIntoViewOptions) {
|
|
@@ -151,7 +152,7 @@ function setupScrollRestoration(router, force) {
|
|
|
151
152
|
router.resetNextScroll = true;
|
|
152
153
|
return;
|
|
153
154
|
}
|
|
154
|
-
restoreScroll(storageKey, cacheKey, router.options.scrollRestorationBehavior, router.isScrollRestoring, router.options.scrollToTopSelectors);
|
|
155
|
+
restoreScroll(router.history, storageKey, cacheKey, router.options.scrollRestorationBehavior, router.isScrollRestoring, router.options.scrollToTopSelectors);
|
|
155
156
|
if (router.isScrollRestoring) {
|
|
156
157
|
scrollRestorationCache.set((state) => {
|
|
157
158
|
state[cacheKey] = state[cacheKey] || {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"scroll-restoration.js","sources":["../../src/scroll-restoration.tsx"],"sourcesContent":["import { functionalUpdate } from '@tanstack/router-core'\nimport { useRouter } from './useRouter'\nimport { ScriptOnce } from './ScriptOnce'\n\nimport type {\n AnyRouter,\n NonNullableUpdater,\n ParsedLocation,\n} from '@tanstack/router-core'\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\nexport const storageKey = 'tsr-scroll-restoration-v1_3'\nlet sessionsStorage = false\ntry {\n sessionsStorage =\n typeof window !== 'undefined' && typeof window.sessionStorage === 'object'\n} catch {}\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}\nexport const scrollRestorationCache: ScrollRestorationCache = sessionsStorage\n ? (() => {\n const state: ScrollRestorationByKey =\n JSON.parse(window.sessionStorage.getItem(storageKey) || 'null') || {}\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 (scrollRestorationCache.state =\n functionalUpdate(updater, scrollRestorationCache.state) ||\n scrollRestorationCache.state),\n window.sessionStorage.setItem(\n storageKey,\n JSON.stringify(scrollRestorationCache.state),\n )\n ),\n }\n })()\n : (undefined as any)\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\nexport const defaultGetScrollRestorationKey = (location: ParsedLocation) => {\n return location.state.key! || location.href\n}\n\nexport function getCssSelector(el: any): string {\n const path = []\n let parent\n while ((parent = el.parentNode)) {\n path.unshift(\n `${el.tagName}:nth-child(${([].indexOf as any).call(parent.children, el) + 1})`,\n )\n el = parent\n }\n return `${path.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: string,\n key?: string,\n behavior?: ScrollToOptions['behavior'],\n shouldScrollRestoration?: boolean,\n scrollToTopSelectors?: Array<string>,\n) {\n let byKey: ScrollRestorationByKey\n\n try {\n byKey = JSON.parse(sessionStorage.getItem(storageKey) || '{}')\n } catch (error: any) {\n console.error(error)\n return\n }\n\n const resolvedKey = key || window.history.state?.key\n const elementEntries = byKey[resolvedKey]\n\n //\n ignoreScroll = true\n\n //\n ;(() => {\n // If we have a cached entry for this location state,\n // we always need to prefer that over the hash scroll.\n if (shouldScrollRestoration && elementEntries) {\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 return\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 = window.location.hash.split('#')[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 // 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 ;[\n 'window',\n ...(scrollToTopSelectors?.filter((d) => d !== 'window') ?? []),\n ].forEach((selector) => {\n const element =\n selector === 'window' ? window : document.querySelector(selector)\n if (element) {\n element.scrollTo({\n top: 0,\n left: 0,\n behavior,\n })\n }\n })\n })()\n\n //\n ignoreScroll = false\n}\n\nexport function setupScrollRestoration(router: AnyRouter, force?: boolean) {\n const shouldScrollRestoration =\n force ?? router.options.scrollRestoration ?? false\n\n if (shouldScrollRestoration) {\n router.isScrollRestoring = true\n }\n\n if (typeof document === 'undefined' || router.isScrollRestorationSetup) {\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.state.location),\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.state.location)\n\n scrollRestorationCache.set((state) => {\n const keyEntry = (state[restoreKey] =\n state[restoreKey] || ({} as ScrollRestorationByElement))\n\n const elementEntry = (keyEntry[elementSelector] =\n keyEntry[elementSelector] || ({} 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\n restoreScroll(\n storageKey,\n cacheKey,\n router.options.scrollRestorationBehavior,\n router.isScrollRestoring,\n router.options.scrollToTopSelectors,\n )\n\n if (router.isScrollRestoring) {\n // Mark the location as having been seen\n scrollRestorationCache.set((state) => {\n state[cacheKey] = state[cacheKey] || ({} as ScrollRestorationByElement)\n\n return state\n })\n }\n })\n}\n\nexport function ScrollRestoration() {\n const router = useRouter()\n const getKey =\n router.options.getScrollRestorationKey || defaultGetScrollRestorationKey\n const userKey = getKey(router.latestLocation)\n const resolvedKey =\n userKey !== defaultGetScrollRestorationKey(router.latestLocation)\n ? userKey\n : null\n\n if (!router.isScrollRestoring || !router.isServer) {\n return null\n }\n\n return (\n <ScriptOnce\n children={`(${restoreScroll.toString()})(${JSON.stringify(storageKey)},${JSON.stringify(resolvedKey)}, undefined, true)`}\n log={false}\n />\n )\n}\n"],"names":["storageKey","sessionsStorage","window","sessionStorage","throttle","fn","wait","timeout","args","setTimeout","scrollRestorationCache","state","JSON","parse","getItem","set","updater","functionalUpdate","setItem","stringify","undefined","defaultGetScrollRestorationKey","location","key","href","getCssSelector","el","path","parent","parentNode","unshift","tagName","indexOf","call","children","join","toLowerCase","ignoreScroll","restoreScroll","behavior","shouldScrollRestoration","scrollToTopSelectors","byKey","error","console","resolvedKey","history","elementEntries","elementSelector","entry","scrollTo","top","scrollY","left","scrollX","element","document","querySelector","scrollLeft","scrollTop","hash","split","hashScrollIntoViewOptions","__hashScrollIntoViewOptions","getElementById","scrollIntoView","filter","d","forEach","selector","setupScrollRestoration","router","force","options","scrollRestoration","isScrollRestoring","isScrollRestorationSetup","getKey","getScrollRestorationKey","onScroll","event","target","attrId","getAttribute","restoreKey","keyEntry","elementEntry","addEventListener","subscribe","cacheKey","toLocation","resetNextScroll","scrollRestorationBehavior","ScrollRestoration","useRouter","userKey","latestLocation","isServer","_$createComponent","ScriptOnce","toString","log"],"mappings":";;;;AAyBO,MAAMA,aAAa;AAC1B,IAAIC,kBAAkB;AACtB,IAAI;AACFA,oBACE,OAAOC,WAAW,eAAe,OAAOA,OAAOC,mBAAmB;AACtE,QAAQ;AAAC;AACT,MAAMC,WAAWA,CAACC,IAAmCC,SAAiB;AAChEC,MAAAA;AACJ,SAAO,IAAIC,SAAqB;AAC9B,QAAI,CAACD,SAAS;AACZA,gBAAUE,WAAW,MAAM;AACzBJ,WAAG,GAAGG,IAAI;AACA,kBAAA;AAAA,SACTF,IAAI;AAAA,IAAA;AAAA,EAEX;AACF;AACaI,MAAAA,yBAAiDT,mBACzD,MAAM;AACCU,QAAAA,QACJC,KAAKC,MAAMX,OAAOC,eAAeW,QAAQd,UAAU,KAAK,MAAM,KAAK,CAAC;AAE/D,SAAA;AAAA,IACLW;AAAAA;AAAAA;AAAAA;AAAAA,IAIAI,KAAMC,CACHN,aAAAA,uBAAuBC,QACtBM,iBAAiBD,SAASN,uBAAuBC,KAAK,KACtDD,uBAAuBC,OACzBT,OAAOC,eAAee,QACpBlB,YACAY,KAAKO,UAAUT,uBAAuBC,KAAK,CAC7C;AAAA,EAEJ;AACF,OACCS;AAQQC,MAAAA,iCAAiCA,CAACC,aAA6B;AACnEA,SAAAA,SAASX,MAAMY,OAAQD,SAASE;AACzC;AAEO,SAASC,eAAeC,IAAiB;AAC9C,QAAMC,OAAO,CAAE;AACXC,MAAAA;AACIA,SAAAA,SAASF,GAAGG,YAAa;AAC/BF,SAAKG,QACH,GAAGJ,GAAGK,OAAO,cAAe,CAAE,EAACC,QAAgBC,KAAKL,OAAOM,UAAUR,EAAE,IAAI,CAAC,GAC9E;AACKE,SAAAA;AAAAA,EAAAA;AAEP,SAAO,GAAGD,KAAKQ,KAAK,KAAK,CAAC,GAAGC,YAAY;AAC3C;AAEA,IAAIC,eAAe;AAMZ,SAASC,cACdtC,aACAuB,KACAgB,UACAC,yBACAC,sBACA;;AACIC,MAAAA;AAEA,MAAA;AACFA,YAAQ9B,KAAKC,MAAMV,eAAeW,QAAQd,WAAU,KAAK,IAAI;AAAA,WACtD2C,OAAY;AACnBC,YAAQD,MAAMA,KAAK;AACnB;AAAA,EAAA;AAGF,QAAME,cAActB,SAAOrB,YAAO4C,QAAQnC,UAAfT,mBAAsBqB;AAC3CwB,QAAAA,iBAAiBL,MAAMG,WAAW;AAGzB,iBAAA;AAGd,GAAC,MAAM;AAGN,QAAIL,2BAA2BO,gBAAgB;AAC7C,iBAAWC,mBAAmBD,gBAAgB;AACtCE,cAAAA,QAAQF,eAAeC,eAAe;AAC5C,YAAIA,oBAAoB,UAAU;AAChC9C,iBAAOgD,SAAS;AAAA,YACdC,KAAKF,MAAMG;AAAAA,YACXC,MAAMJ,MAAMK;AAAAA,YACZf;AAAAA,UAAAA,CACD;AAAA,mBACQS,iBAAiB;AACpBO,gBAAAA,UAAUC,SAASC,cAAcT,eAAe;AACtD,cAAIO,SAAS;AACXA,oBAAQG,aAAaT,MAAMK;AAC3BC,oBAAQI,YAAYV,MAAMG;AAAAA,UAAAA;AAAAA,QAC5B;AAAA,MACF;AAGF;AAAA,IAAA;AAOF,UAAMQ,OAAO1D,OAAOoB,SAASsC,KAAKC,MAAM,GAAG,EAAE,CAAC;AAE9C,QAAID,MAAM;AACR,YAAME,6BACH5D,OAAO4C,QAAQnC,SAAS,CAAA,GAAIoD,+BAA+B;AAE9D,UAAID,2BAA2B;AACvBpC,cAAAA,KAAK8B,SAASQ,eAAeJ,IAAI;AACvC,YAAIlC,IAAI;AACNA,aAAGuC,eAAeH,yBAAyB;AAAA,QAAA;AAAA,MAC7C;AAGF;AAAA,IAAA;AAKD,KACC,UACA,IAAIrB,6DAAsByB,OAAQC,CAAMA,MAAAA,MAAM,cAAa,CAAG,CAAA,EAC9DC,QAASC,CAAa,aAAA;AACtB,YAAMd,UACJc,aAAa,WAAWnE,SAASsD,SAASC,cAAcY,QAAQ;AAClE,UAAId,SAAS;AACXA,gBAAQL,SAAS;AAAA,UACfC,KAAK;AAAA,UACLE,MAAM;AAAA,UACNd;AAAAA,QAAAA,CACD;AAAA,MAAA;AAAA,IACH,CACD;AAAA,EAAA,GACA;AAGY,iBAAA;AACjB;AAEgB+B,SAAAA,uBAAuBC,QAAmBC,OAAiB;AACzE,QAAMhC,0BACJgC,SAASD,OAAOE,QAAQC,qBAAqB;AAE/C,MAAIlC,yBAAyB;AAC3B+B,WAAOI,oBAAoB;AAAA,EAAA;AAG7B,MAAI,OAAOnB,aAAa,eAAee,OAAOK,0BAA0B;AACtE;AAAA,EAAA;AAGFL,SAAOK,2BAA2B;AAGnB,iBAAA;AAETC,QAAAA,SACJN,OAAOE,QAAQK,2BAA2BzD;AAE5CnB,SAAO4C,QAAQ4B,oBAAoB;AAuC7BK,QAAAA,WAAWA,CAACC,UAAiB;AAG7B3C,QAAAA,gBAAgB,CAACkC,OAAOI,mBAAmB;AAC7C;AAAA,IAAA;AAGF,QAAI3B,kBAAkB;AAEtB,QAAIgC,MAAMC,WAAWzB,YAAYwB,MAAMC,WAAW/E,QAAQ;AACtC,wBAAA;AAAA,IAAA,OACb;AACL,YAAMgF,SAAUF,MAAMC,OAAmBE,aACvC,4BACF;AAEA,UAAID,QAAQ;AACVlC,0BAAkB,gCAAgCkC,MAAM;AAAA,MAAA,OACnD;AACazD,0BAAAA,eAAeuD,MAAMC,MAAM;AAAA,MAAA;AAAA,IAC/C;AAGF,UAAMG,aAAaP,OAAON,OAAO5D,MAAMW,QAAQ;AAE/CZ,2BAAuBK,IAAKJ,CAAU,UAAA;AACpC,YAAM0E,WAAY1E,MAAMyE,UAAU,IAChCzE,MAAMyE,UAAU,KAAM,CAAC;AAEzB,YAAME,eAAgBD,SAASrC,eAAe,IAC5CqC,SAASrC,eAAe,KAAM,CAAC;AAEjC,UAAIA,oBAAoB,UAAU;AACnBM,qBAAAA,UAAUpD,OAAOoD,WAAW;AAC5BF,qBAAAA,UAAUlD,OAAOkD,WAAW;AAAA,iBAChCJ,iBAAiB;AACpBO,cAAAA,UAAUC,SAASC,cAAcT,eAAe;AACtD,YAAIO,SAAS;AACED,uBAAAA,UAAUC,QAAQG,cAAc;AAChCN,uBAAAA,UAAUG,QAAQI,aAAa;AAAA,QAAA;AAAA,MAC9C;AAGKhD,aAAAA;AAAAA,IAAAA,CACR;AAAA,EACH;AAGI,MAAA,OAAO6C,aAAa,aAAa;AACnCA,aAAS+B,iBAAiB,UAAUnF,SAAS2E,UAAU,GAAG,GAAG,IAAI;AAAA,EAAA;AAG5DS,SAAAA,UAAU,cAAeR,CAAU,UAAA;AAGlCS,UAAAA,WAAWZ,OAAOG,MAAMU,UAAU;AAIpC,QAAA,CAACnB,OAAOoB,iBAAiB;AAC3BpB,aAAOoB,kBAAkB;AACzB;AAAA,IAAA;AAIA3F,kBAAAA,YACAyF,UACAlB,OAAOE,QAAQmB,2BACfrB,OAAOI,mBACPJ,OAAOE,QAAQhC,oBACjB;AAEA,QAAI8B,OAAOI,mBAAmB;AAE5BjE,6BAAuBK,IAAKJ,CAAU,UAAA;AACpCA,cAAM8E,QAAQ,IAAI9E,MAAM8E,QAAQ,KAAM,CAAC;AAEhC9E,eAAAA;AAAAA,MAAAA,CACR;AAAA,IAAA;AAAA,EACH,CACD;AACH;AAEO,SAASkF,oBAAoB;AAClC,QAAMtB,SAASuB,UAAU;AACnBjB,QAAAA,SACJN,OAAOE,QAAQK,2BAA2BzD;AACtC0E,QAAAA,UAAUlB,OAAON,OAAOyB,cAAc;AAC5C,QAAMnD,cACJkD,YAAY1E,+BAA+BkD,OAAOyB,cAAc,IAC5DD,UACA;AAEN,MAAI,CAACxB,OAAOI,qBAAqB,CAACJ,OAAO0B,UAAU;AAC1C,WAAA;AAAA,EAAA;AAGT,SAAAC,gBACGC,YAAU;AAAA,IAAA,IACTjE,WAAQ;AAAA,aAAE,IAAII,cAAc8D,SAAS,CAAC,KAAKxF,KAAKO,UAAUnB,UAAU,CAAC,IAAIY,KAAKO,UAAU0B,WAAW,CAAC;AAAA,IAAoB;AAAA,IACxHwD,KAAK;AAAA,EAAA,CAAK;AAGhB;"}
|
|
1
|
+
{"version":3,"file":"scroll-restoration.js","sources":["../../src/scroll-restoration.tsx"],"sourcesContent":["import { functionalUpdate } from '@tanstack/router-core'\nimport { useRouter } from './useRouter'\nimport { ScriptOnce } from './ScriptOnce'\n\nimport type {\n AnyRouter,\n NonNullableUpdater,\n ParsedLocation,\n} from '@tanstack/router-core'\nimport type { RouterHistory } 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\nexport const storageKey = 'tsr-scroll-restoration-v1_3'\nlet sessionsStorage = false\ntry {\n sessionsStorage =\n typeof window !== 'undefined' && typeof window.sessionStorage === 'object'\n} catch {}\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}\nexport const scrollRestorationCache: ScrollRestorationCache = sessionsStorage\n ? (() => {\n const state: ScrollRestorationByKey =\n JSON.parse(window.sessionStorage.getItem(storageKey) || 'null') || {}\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 (scrollRestorationCache.state =\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n functionalUpdate(updater, scrollRestorationCache.state) ||\n scrollRestorationCache.state),\n window.sessionStorage.setItem(\n storageKey,\n JSON.stringify(scrollRestorationCache.state),\n )\n ),\n }\n })()\n : (undefined as any)\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\nexport const defaultGetScrollRestorationKey = (location: ParsedLocation) => {\n return location.state.key! || location.href\n}\n\nexport function getCssSelector(el: any): string {\n const path = []\n let parent\n while ((parent = el.parentNode)) {\n path.unshift(\n `${el.tagName}:nth-child(${([].indexOf as any).call(parent.children, el) + 1})`,\n )\n el = parent\n }\n return `${path.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 routerHistory: RouterHistory,\n storageKey: string,\n key?: string,\n behavior?: ScrollToOptions['behavior'],\n shouldScrollRestoration?: boolean,\n scrollToTopSelectors?: Array<string>,\n) {\n let byKey: ScrollRestorationByKey\n\n try {\n byKey = JSON.parse(sessionStorage.getItem(storageKey) || '{}')\n } catch (error: any) {\n console.error(error)\n return\n }\n\n const resolvedKey = key || window.history.state?.key\n const elementEntries = byKey[resolvedKey]\n\n //\n ignoreScroll = true\n\n //\n ;(() => {\n // If we have a cached entry for this location state,\n // we always need to prefer that over the hash scroll.\n if (shouldScrollRestoration && elementEntries) {\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 return\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 = routerHistory.location.hash.split('#')[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 // 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 ;[\n 'window',\n ...(scrollToTopSelectors?.filter((d) => d !== 'window') ?? []),\n ].forEach((selector) => {\n const element =\n selector === 'window' ? window : document.querySelector(selector)\n if (element) {\n element.scrollTo({\n top: 0,\n left: 0,\n behavior,\n })\n }\n })\n })()\n\n //\n ignoreScroll = false\n}\n\nexport function setupScrollRestoration(router: AnyRouter, force?: boolean) {\n const shouldScrollRestoration =\n force ?? router.options.scrollRestoration ?? false\n\n if (shouldScrollRestoration) {\n router.isScrollRestoring = true\n }\n\n if (typeof document === 'undefined' || router.isScrollRestorationSetup) {\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.state.location),\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.state.location)\n\n scrollRestorationCache.set((state) => {\n const keyEntry = (state[restoreKey] =\n state[restoreKey] || ({} as ScrollRestorationByElement))\n\n const elementEntry = (keyEntry[elementSelector] =\n keyEntry[elementSelector] || ({} 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\n restoreScroll(\n router.history,\n storageKey,\n cacheKey,\n router.options.scrollRestorationBehavior,\n router.isScrollRestoring,\n router.options.scrollToTopSelectors,\n )\n\n if (router.isScrollRestoring) {\n // Mark the location as having been seen\n scrollRestorationCache.set((state) => {\n state[cacheKey] = state[cacheKey] || ({} as ScrollRestorationByElement)\n\n return state\n })\n }\n })\n}\n\nexport function ScrollRestoration() {\n const router = useRouter()\n const getKey =\n router.options.getScrollRestorationKey || defaultGetScrollRestorationKey\n const userKey = getKey(router.latestLocation)\n const resolvedKey =\n userKey !== defaultGetScrollRestorationKey(router.latestLocation)\n ? userKey\n : null\n\n if (!router.isScrollRestoring || !router.isServer) {\n return null\n }\n\n return (\n <ScriptOnce\n children={`(${restoreScroll.toString()})(${JSON.stringify(storageKey)},${JSON.stringify(resolvedKey)}, undefined, true)`}\n log={false}\n />\n )\n}\n"],"names":["storageKey","sessionsStorage","window","sessionStorage","throttle","fn","wait","timeout","args","setTimeout","scrollRestorationCache","state","JSON","parse","getItem","set","updater","functionalUpdate","setItem","stringify","undefined","defaultGetScrollRestorationKey","location","key","href","getCssSelector","el","path","parent","parentNode","unshift","tagName","indexOf","call","children","join","toLowerCase","ignoreScroll","restoreScroll","routerHistory","behavior","shouldScrollRestoration","scrollToTopSelectors","byKey","error","console","resolvedKey","history","elementEntries","elementSelector","entry","scrollTo","top","scrollY","left","scrollX","element","document","querySelector","scrollLeft","scrollTop","hash","split","hashScrollIntoViewOptions","__hashScrollIntoViewOptions","getElementById","scrollIntoView","filter","d","forEach","selector","setupScrollRestoration","router","force","options","scrollRestoration","isScrollRestoring","isScrollRestorationSetup","getKey","getScrollRestorationKey","onScroll","event","target","attrId","getAttribute","restoreKey","keyEntry","elementEntry","addEventListener","subscribe","cacheKey","toLocation","resetNextScroll","scrollRestorationBehavior","ScrollRestoration","useRouter","userKey","latestLocation","isServer","_$createComponent","ScriptOnce","toString","log"],"mappings":";;;;AA0BO,MAAMA,aAAa;AAC1B,IAAIC,kBAAkB;AACtB,IAAI;AACFA,oBACE,OAAOC,WAAW,eAAe,OAAOA,OAAOC,mBAAmB;AACtE,QAAQ;AAAC;AACT,MAAMC,WAAWA,CAACC,IAAmCC,SAAiB;AAChEC,MAAAA;AACJ,SAAO,IAAIC,SAAqB;AAC9B,QAAI,CAACD,SAAS;AACZA,gBAAUE,WAAW,MAAM;AACzBJ,WAAG,GAAGG,IAAI;AACA,kBAAA;AAAA,SACTF,IAAI;AAAA,IAAA;AAAA,EAEX;AACF;AACaI,MAAAA,yBAAiDT,mBACzD,MAAM;AACCU,QAAAA,QACJC,KAAKC,MAAMX,OAAOC,eAAeW,QAAQd,UAAU,KAAK,MAAM,KAAK,CAAC;AAE/D,SAAA;AAAA,IACLW;AAAAA;AAAAA;AAAAA;AAAAA,IAIAI,KAAMC,cACHN,uBAAuBC;AAAAA,IAEtBM,iBAAiBD,SAASN,uBAAuBC,KAAK,KACtDD,uBAAuBC,OACzBT,OAAOC,eAAee,QACpBlB,YACAY,KAAKO,UAAUT,uBAAuBC,KAAK,CAC7C;AAAA,EAEJ;AACF,OACCS;AAQQC,MAAAA,iCAAiCA,CAACC,aAA6B;AACnEA,SAAAA,SAASX,MAAMY,OAAQD,SAASE;AACzC;AAEO,SAASC,eAAeC,IAAiB;AAC9C,QAAMC,OAAO,CAAE;AACXC,MAAAA;AACIA,SAAAA,SAASF,GAAGG,YAAa;AAC/BF,SAAKG,QACH,GAAGJ,GAAGK,OAAO,cAAe,CAAE,EAACC,QAAgBC,KAAKL,OAAOM,UAAUR,EAAE,IAAI,CAAC,GAC9E;AACKE,SAAAA;AAAAA,EAAAA;AAEP,SAAO,GAAGD,KAAKQ,KAAK,KAAK,CAAC,GAAGC,YAAY;AAC3C;AAEA,IAAIC,eAAe;AAMZ,SAASC,cACdC,eACAvC,aACAuB,KACAiB,UACAC,yBACAC,sBACA;;AACIC,MAAAA;AAEA,MAAA;AACFA,YAAQ/B,KAAKC,MAAMV,eAAeW,QAAQd,WAAU,KAAK,IAAI;AAAA,WACtD4C,OAAY;AACnBC,YAAQD,MAAMA,KAAK;AACnB;AAAA,EAAA;AAGF,QAAME,cAAcvB,SAAOrB,YAAO6C,QAAQpC,UAAfT,mBAAsBqB;AAC3CyB,QAAAA,iBAAiBL,MAAMG,WAAW;AAGzB,iBAAA;AAGd,GAAC,MAAM;AAGN,QAAIL,2BAA2BO,gBAAgB;AAC7C,iBAAWC,mBAAmBD,gBAAgB;AACtCE,cAAAA,QAAQF,eAAeC,eAAe;AAC5C,YAAIA,oBAAoB,UAAU;AAChC/C,iBAAOiD,SAAS;AAAA,YACdC,KAAKF,MAAMG;AAAAA,YACXC,MAAMJ,MAAMK;AAAAA,YACZf;AAAAA,UAAAA,CACD;AAAA,mBACQS,iBAAiB;AACpBO,gBAAAA,UAAUC,SAASC,cAAcT,eAAe;AACtD,cAAIO,SAAS;AACXA,oBAAQG,aAAaT,MAAMK;AAC3BC,oBAAQI,YAAYV,MAAMG;AAAAA,UAAAA;AAAAA,QAC5B;AAAA,MACF;AAGF;AAAA,IAAA;AAOF,UAAMQ,OAAOtB,cAAcjB,SAASuC,KAAKC,MAAM,GAAG,EAAE,CAAC;AAErD,QAAID,MAAM;AACR,YAAME,6BACH7D,OAAO6C,QAAQpC,SAAS,CAAA,GAAIqD,+BAA+B;AAE9D,UAAID,2BAA2B;AACvBrC,cAAAA,KAAK+B,SAASQ,eAAeJ,IAAI;AACvC,YAAInC,IAAI;AACNA,aAAGwC,eAAeH,yBAAyB;AAAA,QAAA;AAAA,MAC7C;AAGF;AAAA,IAAA;AAKD,KACC,UACA,IAAIrB,6DAAsByB,OAAQC,CAAMA,MAAAA,MAAM,cAAa,CAAG,CAAA,EAC9DC,QAASC,CAAa,aAAA;AACtB,YAAMd,UACJc,aAAa,WAAWpE,SAASuD,SAASC,cAAcY,QAAQ;AAClE,UAAId,SAAS;AACXA,gBAAQL,SAAS;AAAA,UACfC,KAAK;AAAA,UACLE,MAAM;AAAA,UACNd;AAAAA,QAAAA,CACD;AAAA,MAAA;AAAA,IACH,CACD;AAAA,EAAA,GACA;AAGY,iBAAA;AACjB;AAEgB+B,SAAAA,uBAAuBC,QAAmBC,OAAiB;AACzE,QAAMhC,0BACJgC,SAASD,OAAOE,QAAQC,qBAAqB;AAE/C,MAAIlC,yBAAyB;AAC3B+B,WAAOI,oBAAoB;AAAA,EAAA;AAG7B,MAAI,OAAOnB,aAAa,eAAee,OAAOK,0BAA0B;AACtE;AAAA,EAAA;AAGFL,SAAOK,2BAA2B;AAGnB,iBAAA;AAETC,QAAAA,SACJN,OAAOE,QAAQK,2BAA2B1D;AAE5CnB,SAAO6C,QAAQ4B,oBAAoB;AAuC7BK,QAAAA,WAAWA,CAACC,UAAiB;AAG7B5C,QAAAA,gBAAgB,CAACmC,OAAOI,mBAAmB;AAC7C;AAAA,IAAA;AAGF,QAAI3B,kBAAkB;AAEtB,QAAIgC,MAAMC,WAAWzB,YAAYwB,MAAMC,WAAWhF,QAAQ;AACtC,wBAAA;AAAA,IAAA,OACb;AACL,YAAMiF,SAAUF,MAAMC,OAAmBE,aACvC,4BACF;AAEA,UAAID,QAAQ;AACVlC,0BAAkB,gCAAgCkC,MAAM;AAAA,MAAA,OACnD;AACa1D,0BAAAA,eAAewD,MAAMC,MAAM;AAAA,MAAA;AAAA,IAC/C;AAGF,UAAMG,aAAaP,OAAON,OAAO7D,MAAMW,QAAQ;AAE/CZ,2BAAuBK,IAAKJ,CAAU,UAAA;AACpC,YAAM2E,WAAY3E,MAAM0E,UAAU,IAChC1E,MAAM0E,UAAU,KAAM,CAAC;AAEzB,YAAME,eAAgBD,SAASrC,eAAe,IAC5CqC,SAASrC,eAAe,KAAM,CAAC;AAEjC,UAAIA,oBAAoB,UAAU;AACnBM,qBAAAA,UAAUrD,OAAOqD,WAAW;AAC5BF,qBAAAA,UAAUnD,OAAOmD,WAAW;AAAA,iBAChCJ,iBAAiB;AACpBO,cAAAA,UAAUC,SAASC,cAAcT,eAAe;AACtD,YAAIO,SAAS;AACED,uBAAAA,UAAUC,QAAQG,cAAc;AAChCN,uBAAAA,UAAUG,QAAQI,aAAa;AAAA,QAAA;AAAA,MAC9C;AAGKjD,aAAAA;AAAAA,IAAAA,CACR;AAAA,EACH;AAGI,MAAA,OAAO8C,aAAa,aAAa;AACnCA,aAAS+B,iBAAiB,UAAUpF,SAAS4E,UAAU,GAAG,GAAG,IAAI;AAAA,EAAA;AAG5DS,SAAAA,UAAU,cAAeR,CAAU,UAAA;AAGlCS,UAAAA,WAAWZ,OAAOG,MAAMU,UAAU;AAIpC,QAAA,CAACnB,OAAOoB,iBAAiB;AAC3BpB,aAAOoB,kBAAkB;AACzB;AAAA,IAAA;AAIApB,kBAAAA,OAAOzB,SACP/C,YACA0F,UACAlB,OAAOE,QAAQmB,2BACfrB,OAAOI,mBACPJ,OAAOE,QAAQhC,oBACjB;AAEA,QAAI8B,OAAOI,mBAAmB;AAE5BlE,6BAAuBK,IAAKJ,CAAU,UAAA;AACpCA,cAAM+E,QAAQ,IAAI/E,MAAM+E,QAAQ,KAAM,CAAC;AAEhC/E,eAAAA;AAAAA,MAAAA,CACR;AAAA,IAAA;AAAA,EACH,CACD;AACH;AAEO,SAASmF,oBAAoB;AAClC,QAAMtB,SAASuB,UAAU;AACnBjB,QAAAA,SACJN,OAAOE,QAAQK,2BAA2B1D;AACtC2E,QAAAA,UAAUlB,OAAON,OAAOyB,cAAc;AAC5C,QAAMnD,cACJkD,YAAY3E,+BAA+BmD,OAAOyB,cAAc,IAC5DD,UACA;AAEN,MAAI,CAACxB,OAAOI,qBAAqB,CAACJ,OAAO0B,UAAU;AAC1C,WAAA;AAAA,EAAA;AAGT,SAAAC,gBACGC,YAAU;AAAA,IAAA,IACTlE,WAAQ;AAAA,aAAE,IAAII,cAAc+D,SAAS,CAAC,KAAKzF,KAAKO,UAAUnB,UAAU,CAAC,IAAIY,KAAKO,UAAU2B,WAAW,CAAC;AAAA,IAAoB;AAAA,IACxHwD,KAAK;AAAA,EAAA,CAAK;AAGhB;"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { AnyRouter, NonNullableUpdater, ParsedLocation } from '@tanstack/router-core';
|
|
2
|
+
import type { RouterHistory } from '@tanstack/history';
|
|
2
3
|
export type ScrollRestorationEntry = {
|
|
3
4
|
scrollX: number;
|
|
4
5
|
scrollY: number;
|
|
@@ -23,6 +24,6 @@ export declare const scrollRestorationCache: ScrollRestorationCache;
|
|
|
23
24
|
*/
|
|
24
25
|
export declare const defaultGetScrollRestorationKey: (location: ParsedLocation) => string;
|
|
25
26
|
export declare function getCssSelector(el: any): string;
|
|
26
|
-
export declare function restoreScroll(storageKey: string, key?: string, behavior?: ScrollToOptions['behavior'], shouldScrollRestoration?: boolean, scrollToTopSelectors?: Array<string>): void;
|
|
27
|
+
export declare function restoreScroll(routerHistory: RouterHistory, storageKey: string, key?: string, behavior?: ScrollToOptions['behavior'], shouldScrollRestoration?: boolean, scrollToTopSelectors?: Array<string>): void;
|
|
27
28
|
export declare function setupScrollRestoration(router: AnyRouter, force?: boolean): void;
|
|
28
29
|
export declare function ScrollRestoration(): import("solid-js").JSX.Element;
|
|
@@ -28,6 +28,7 @@ export const scrollRestorationCache = sessionsStorage
|
|
|
28
28
|
// after the state is updated. It doesn't necessarily need to be a functional
|
|
29
29
|
// update.
|
|
30
30
|
set: (updater) => ((scrollRestorationCache.state =
|
|
31
|
+
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
|
31
32
|
functionalUpdate(updater, scrollRestorationCache.state) ||
|
|
32
33
|
scrollRestorationCache.state),
|
|
33
34
|
window.sessionStorage.setItem(storageKey, JSON.stringify(scrollRestorationCache.state))),
|
|
@@ -57,7 +58,7 @@ let ignoreScroll = false;
|
|
|
57
58
|
// unless they are passed in as arguments. Why? Because we need to be able to
|
|
58
59
|
// toString() it into a script tag to execute as early as possible in the browser
|
|
59
60
|
// during SSR. Additionally, we also call it from within the router lifecycle
|
|
60
|
-
export function restoreScroll(storageKey, key, behavior, shouldScrollRestoration, scrollToTopSelectors) {
|
|
61
|
+
export function restoreScroll(routerHistory, storageKey, key, behavior, shouldScrollRestoration, scrollToTopSelectors) {
|
|
61
62
|
let byKey;
|
|
62
63
|
try {
|
|
63
64
|
byKey = JSON.parse(sessionStorage.getItem(storageKey) || '{}');
|
|
@@ -97,7 +98,7 @@ export function restoreScroll(storageKey, key, behavior, shouldScrollRestoration
|
|
|
97
98
|
// Which means we've never seen this location before,
|
|
98
99
|
// we need to check if there is a hash in the URL.
|
|
99
100
|
// If there is, we need to scroll it's ID into view.
|
|
100
|
-
const hash =
|
|
101
|
+
const hash = routerHistory.location.hash.split('#')[1];
|
|
101
102
|
if (hash) {
|
|
102
103
|
const hashScrollIntoViewOptions = (window.history.state || {}).__hashScrollIntoViewOptions ?? true;
|
|
103
104
|
if (hashScrollIntoViewOptions) {
|
|
@@ -224,7 +225,7 @@ export function setupScrollRestoration(router, force) {
|
|
|
224
225
|
router.resetNextScroll = true;
|
|
225
226
|
return;
|
|
226
227
|
}
|
|
227
|
-
restoreScroll(storageKey, cacheKey, router.options.scrollRestorationBehavior, router.isScrollRestoring, router.options.scrollToTopSelectors);
|
|
228
|
+
restoreScroll(router.history, storageKey, cacheKey, router.options.scrollRestorationBehavior, router.isScrollRestoring, router.options.scrollToTopSelectors);
|
|
228
229
|
if (router.isScrollRestoring) {
|
|
229
230
|
// Mark the location as having been seen
|
|
230
231
|
scrollRestorationCache.set((state) => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"scroll-restoration.jsx","sourceRoot":"","sources":["../../src/scroll-restoration.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;
|
|
1
|
+
{"version":3,"file":"scroll-restoration.jsx","sourceRoot":"","sources":["../../src/scroll-restoration.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAwBzC,MAAM,CAAC,MAAM,UAAU,GAAG,6BAA6B,CAAA;AACvD,IAAI,eAAe,GAAG,KAAK,CAAA;AAC3B,IAAI,CAAC;IACH,eAAe;QACb,OAAO,MAAM,KAAK,WAAW,IAAI,OAAO,MAAM,CAAC,cAAc,KAAK,QAAQ,CAAA;AAC9E,CAAC;AAAC,MAAM,CAAC,CAAA,CAAC;AACV,MAAM,QAAQ,GAAG,CAAC,EAAiC,EAAE,IAAY,EAAE,EAAE;IACnE,IAAI,OAAY,CAAA;IAChB,OAAO,CAAC,GAAG,IAAgB,EAAE,EAAE;QAC7B,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;gBACxB,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;gBACX,OAAO,GAAG,IAAI,CAAA;YAChB,CAAC,EAAE,IAAI,CAAC,CAAA;QACV,CAAC;IACH,CAAC,CAAA;AACH,CAAC,CAAA;AACD,MAAM,CAAC,MAAM,sBAAsB,GAA2B,eAAe;IAC3E,CAAC,CAAC,CAAC,GAAG,EAAE;QACJ,MAAM,KAAK,GACT,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,IAAI,EAAE,CAAA;QAEvE,OAAO;YACL,KAAK;YACL,0EAA0E;YAC1E,6EAA6E;YAC7E,UAAU;YACV,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAChB,CAAC,sBAAsB,CAAC,KAAK;gBAC3B,uEAAuE;gBACvE,gBAAgB,CAAC,OAAO,EAAE,sBAAsB,CAAC,KAAK,CAAC;oBACvD,sBAAsB,CAAC,KAAK,CAAC;gBAC/B,MAAM,CAAC,cAAc,CAAC,OAAO,CAC3B,UAAU,EACV,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAC7C,CACF;SACF,CAAA;IACH,CAAC,CAAC,EAAE;IACN,CAAC,CAAE,SAAiB,CAAA;AACtB;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,QAAwB,EAAE,EAAE;IACzE,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAI,IAAI,QAAQ,CAAC,IAAI,CAAA;AAC7C,CAAC,CAAA;AAED,MAAM,UAAU,cAAc,CAAC,EAAO;IACpC,MAAM,IAAI,GAAG,EAAE,CAAA;IACf,IAAI,MAAM,CAAA;IACV,OAAO,CAAC,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC;QAChC,IAAI,CAAC,OAAO,CACV,GAAG,EAAE,CAAC,OAAO,cAAe,EAAE,CAAC,OAAe,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAChF,CAAA;QACD,EAAE,GAAG,MAAM,CAAA;IACb,CAAC;IACD,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,WAAW,EAAE,CAAA;AAC5C,CAAC;AAED,IAAI,YAAY,GAAG,KAAK,CAAA;AAExB,yEAAyE;AACzE,6EAA6E;AAC7E,iFAAiF;AACjF,6EAA6E;AAC7E,MAAM,UAAU,aAAa,CAC3B,aAA4B,EAC5B,UAAkB,EAClB,GAAY,EACZ,QAAsC,EACtC,uBAAiC,EACjC,oBAAoC;IAEpC,IAAI,KAA6B,CAAA;IAEjC,IAAI,CAAC;QACH,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAA;IAChE,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QACpB,OAAM;IACR,CAAC;IAED,MAAM,WAAW,GAAG,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAA;IACpD,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,CAAA;IAEzC,EAAE;IACF,YAAY,GAAG,IAAI,CAGlB;IAAA,CAAC,GAAG,EAAE;QACL,qDAAqD;QACrD,sDAAsD;QACtD,IAAI,uBAAuB,IAAI,cAAc,EAAE,CAAC;YAC9C,KAAK,MAAM,eAAe,IAAI,cAAc,EAAE,CAAC;gBAC7C,MAAM,KAAK,GAAG,cAAc,CAAC,eAAe,CAAE,CAAA;gBAC9C,IAAI,eAAe,KAAK,QAAQ,EAAE,CAAC;oBACjC,MAAM,CAAC,QAAQ,CAAC;wBACd,GAAG,EAAE,KAAK,CAAC,OAAO;wBAClB,IAAI,EAAE,KAAK,CAAC,OAAO;wBACnB,QAAQ;qBACT,CAAC,CAAA;gBACJ,CAAC;qBAAM,IAAI,eAAe,EAAE,CAAC;oBAC3B,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,eAAe,CAAC,CAAA;oBACvD,IAAI,OAAO,EAAE,CAAC;wBACZ,OAAO,CAAC,UAAU,GAAG,KAAK,CAAC,OAAO,CAAA;wBAClC,OAAO,CAAC,SAAS,GAAG,KAAK,CAAC,OAAO,CAAA;oBACnC,CAAC;gBACH,CAAC;YACH,CAAC;YAED,OAAM;QACR,CAAC;QAED,gDAAgD;QAChD,qDAAqD;QACrD,kDAAkD;QAClD,oDAAoD;QACpD,MAAM,IAAI,GAAG,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;QAEtD,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,yBAAyB,GAC7B,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,2BAA2B,IAAI,IAAI,CAAA;YAElE,IAAI,yBAAyB,EAAE,CAAC;gBAC9B,MAAM,EAAE,GAAG,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;gBACxC,IAAI,EAAE,EAAE,CAAC;oBACP,EAAE,CAAC,cAAc,CAAC,yBAAyB,CAAC,CAAA;gBAC9C,CAAC;YACH,CAAC;YAED,OAAM;QACR,CAAC;QAED,4EAA4E;QAC5E,yEAAyE;QACzE,CAAC;QAAA;YACC,QAAQ;YACR,GAAG,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,IAAI,EAAE,CAAC;SAC/D,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YACrB,MAAM,OAAO,GACX,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAA;YACnE,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,CAAC,QAAQ,CAAC;oBACf,GAAG,EAAE,CAAC;oBACN,IAAI,EAAE,CAAC;oBACP,QAAQ;iBACT,CAAC,CAAA;YACJ,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,EAAE,CAAA;IAEJ,EAAE;IACF,YAAY,GAAG,KAAK,CAAA;AACtB,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,MAAiB,EAAE,KAAe;IACvE,MAAM,uBAAuB,GAC3B,KAAK,IAAI,MAAM,CAAC,OAAO,CAAC,iBAAiB,IAAI,KAAK,CAAA;IAEpD,IAAI,uBAAuB,EAAE,CAAC;QAC5B,MAAM,CAAC,iBAAiB,GAAG,IAAI,CAAA;IACjC,CAAC;IAED,IAAI,OAAO,QAAQ,KAAK,WAAW,IAAI,MAAM,CAAC,wBAAwB,EAAE,CAAC;QACvE,OAAM;IACR,CAAC;IAED,MAAM,CAAC,wBAAwB,GAAG,IAAI,CAAA;IAEtC,EAAE;IACF,YAAY,GAAG,KAAK,CAAA;IAEpB,MAAM,MAAM,GACV,MAAM,CAAC,OAAO,CAAC,uBAAuB,IAAI,8BAA8B,CAAA;IAE1E,MAAM,CAAC,OAAO,CAAC,iBAAiB,GAAG,QAAQ,CAAA;IAE3C,sDAAsD;IACtD,wDAAwD;IACxD,yBAAyB;IACzB,kCAAkC;IAClC,4BAA4B;IAE5B,wDAAwD;IACxD,qDAAqD;IACrD,0DAA0D;IAC1D,uDAAuD;IACvD,wDAAwD;IACxD,wDAAwD;IACxD,4BAA4B;IAC5B,wDAAwD;IACxD,qBAAqB;IACrB,oBAAoB;IACpB,uCAAuC;IACvC,kDAAkD;IAClD,QAAQ;IACR,OAAO;IACP,KAAK;IAEL,6BAA6B;IAC7B,8CAA8C;IAC9C,yCAAyC;IACzC,8DAA8D;IAC9D,gDAAgD;IAChD,0DAA0D;IAC1D,OAAO;IACP,IAAI;IAEJ,+BAA+B;IAC/B,kCAAkC;IAClC,IAAI;IAEJ,eAAe;IAEf,MAAM,QAAQ,GAAG,CAAC,KAAY,EAAE,EAAE;QAChC,iBAAiB;QAEjB,IAAI,YAAY,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC;YAC9C,OAAM;QACR,CAAC;QAED,IAAI,eAAe,GAAG,EAAE,CAAA;QAExB,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YACzD,eAAe,GAAG,QAAQ,CAAA;QAC5B,CAAC;aAAM,CAAC;YACN,MAAM,MAAM,GAAI,KAAK,CAAC,MAAkB,CAAC,YAAY,CACnD,4BAA4B,CAC7B,CAAA;YAED,IAAI,MAAM,EAAE,CAAC;gBACX,eAAe,GAAG,gCAAgC,MAAM,IAAI,CAAA;YAC9D,CAAC;iBAAM,CAAC;gBACN,eAAe,GAAG,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;YAChD,CAAC;QACH,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;QAEhD,sBAAsB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACnC,MAAM,QAAQ,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC;gBACjC,KAAK,CAAC,UAAU,CAAC,IAAK,EAAiC,CAAC,CAAA;YAE1D,MAAM,YAAY,GAAG,CAAC,QAAQ,CAAC,eAAe,CAAC;gBAC7C,QAAQ,CAAC,eAAe,CAAC,IAAK,EAA6B,CAAC,CAAA;YAE9D,IAAI,eAAe,KAAK,QAAQ,EAAE,CAAC;gBACjC,YAAY,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,CAAC,CAAA;gBAC1C,YAAY,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,CAAC,CAAA;YAC5C,CAAC;iBAAM,IAAI,eAAe,EAAE,CAAC;gBAC3B,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,eAAe,CAAC,CAAA;gBACvD,IAAI,OAAO,EAAE,CAAC;oBACZ,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC,UAAU,IAAI,CAAC,CAAA;oBAC9C,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC,SAAS,IAAI,CAAC,CAAA;gBAC/C,CAAC;YACH,CAAC;YAED,OAAO,KAAK,CAAA;QACd,CAAC,CAAC,CAAA;IACJ,CAAC,CAAA;IAED,uDAAuD;IACvD,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;QACpC,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE,IAAI,CAAC,CAAA;IACpE,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE;QACvC,iBAAiB;QAEjB,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QAEzC,2DAA2D;QAC3D,gCAAgC;QAChC,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;YAC5B,MAAM,CAAC,eAAe,GAAG,IAAI,CAAA;YAC7B,OAAM;QACR,CAAC;QAED,aAAa,CACX,MAAM,CAAC,OAAO,EACd,UAAU,EACV,QAAQ,EACR,MAAM,CAAC,OAAO,CAAC,yBAAyB,EACxC,MAAM,CAAC,iBAAiB,EACxB,MAAM,CAAC,OAAO,CAAC,oBAAoB,CACpC,CAAA;QAED,IAAI,MAAM,CAAC,iBAAiB,EAAE,CAAC;YAC7B,wCAAwC;YACxC,sBAAsB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;gBACnC,KAAK,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAK,EAAiC,CAAA;gBAEvE,OAAO,KAAK,CAAA;YACd,CAAC,CAAC,CAAA;QACJ,CAAC;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB;IAC/B,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;IAC1B,MAAM,MAAM,GACV,MAAM,CAAC,OAAO,CAAC,uBAAuB,IAAI,8BAA8B,CAAA;IAC1E,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;IAC7C,MAAM,WAAW,GACf,OAAO,KAAK,8BAA8B,CAAC,MAAM,CAAC,cAAc,CAAC;QAC/D,CAAC,CAAC,OAAO;QACT,CAAC,CAAC,IAAI,CAAA;IAEV,IAAI,CAAC,MAAM,CAAC,iBAAiB,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAClD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,CACL,CAAC,UAAU,CACT,QAAQ,CAAC,CAAC,IAAI,aAAa,CAAC,QAAQ,EAAE,KAAK,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACzH,GAAG,CAAC,CAAC,KAAK,CAAC,EACX,CACH,CAAA;AACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tanstack/solid-router",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.114.2",
|
|
4
4
|
"description": "Modern and scalable routing for Solid applications",
|
|
5
5
|
"author": "Tanner Linsley",
|
|
6
6
|
"license": "MIT",
|
|
@@ -60,8 +60,8 @@
|
|
|
60
60
|
"jsesc": "^3.0.2",
|
|
61
61
|
"tiny-invariant": "^1.3.3",
|
|
62
62
|
"tiny-warning": "^1.0.3",
|
|
63
|
-
"@tanstack/history": "1.
|
|
64
|
-
"@tanstack/router-core": "1.
|
|
63
|
+
"@tanstack/history": "1.114.1",
|
|
64
|
+
"@tanstack/router-core": "1.114.1"
|
|
65
65
|
},
|
|
66
66
|
"devDependencies": {
|
|
67
67
|
"@solidjs/testing-library": "^0.8.10",
|
|
@@ -7,6 +7,7 @@ import type {
|
|
|
7
7
|
NonNullableUpdater,
|
|
8
8
|
ParsedLocation,
|
|
9
9
|
} from '@tanstack/router-core'
|
|
10
|
+
import type { RouterHistory } from '@tanstack/history'
|
|
10
11
|
|
|
11
12
|
export type ScrollRestorationEntry = { scrollX: number; scrollY: number }
|
|
12
13
|
|
|
@@ -52,6 +53,7 @@ export const scrollRestorationCache: ScrollRestorationCache = sessionsStorage
|
|
|
52
53
|
// update.
|
|
53
54
|
set: (updater) => (
|
|
54
55
|
(scrollRestorationCache.state =
|
|
56
|
+
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
|
55
57
|
functionalUpdate(updater, scrollRestorationCache.state) ||
|
|
56
58
|
scrollRestorationCache.state),
|
|
57
59
|
window.sessionStorage.setItem(
|
|
@@ -92,6 +94,7 @@ let ignoreScroll = false
|
|
|
92
94
|
// toString() it into a script tag to execute as early as possible in the browser
|
|
93
95
|
// during SSR. Additionally, we also call it from within the router lifecycle
|
|
94
96
|
export function restoreScroll(
|
|
97
|
+
routerHistory: RouterHistory,
|
|
95
98
|
storageKey: string,
|
|
96
99
|
key?: string,
|
|
97
100
|
behavior?: ScrollToOptions['behavior'],
|
|
@@ -142,7 +145,7 @@ export function restoreScroll(
|
|
|
142
145
|
// Which means we've never seen this location before,
|
|
143
146
|
// we need to check if there is a hash in the URL.
|
|
144
147
|
// If there is, we need to scroll it's ID into view.
|
|
145
|
-
const hash =
|
|
148
|
+
const hash = routerHistory.location.hash.split('#')[1]
|
|
146
149
|
|
|
147
150
|
if (hash) {
|
|
148
151
|
const hashScrollIntoViewOptions =
|
|
@@ -304,6 +307,7 @@ export function setupScrollRestoration(router: AnyRouter, force?: boolean) {
|
|
|
304
307
|
}
|
|
305
308
|
|
|
306
309
|
restoreScroll(
|
|
310
|
+
router.history,
|
|
307
311
|
storageKey,
|
|
308
312
|
cacheKey,
|
|
309
313
|
router.options.scrollRestorationBehavior,
|