@tanstack/solid-router 1.114.14 → 1.114.15

package/dist/source/scroll-restoration.jsx

@@ -1,240 +1,6 @@
-import { functionalUpdate } from '@tanstack/router-core';
+import { defaultGetScrollRestorationKey, restoreScroll, storageKey, } from '@tanstack/router-core';
 import { useRouter } from './useRouter';
 import { ScriptOnce } from './ScriptOnce';
-export const storageKey = 'tsr-scroll-restoration-v1_3';
-let sessionsStorage = false;
-try {
-    sessionsStorage =
-        typeof window !== 'undefined' && typeof window.sessionStorage === 'object';
-}
-catch { }
-const throttle = (fn, wait) => {
-    let timeout;
-    return (...args) => {
-        if (!timeout) {
-            timeout = setTimeout(() => {
-                fn(...args);
-                timeout = null;
-            }, wait);
-        }
-    };
-};
-export const scrollRestorationCache = sessionsStorage
-    ? (() => {
-        const state = JSON.parse(window.sessionStorage.getItem(storageKey) || 'null') || {};
-        return {
-            state,
-            // This setter is simply to make sure that we set the sessionStorage right
-            // after the state is updated. It doesn't necessarily need to be a functional
-            // update.
-            set: (updater) => ((scrollRestorationCache.state =
-                // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-                functionalUpdate(updater, scrollRestorationCache.state) ||
-                    scrollRestorationCache.state),
-                window.sessionStorage.setItem(storageKey, JSON.stringify(scrollRestorationCache.state))),
-        };
-    })()
-    : undefined;
-/**
- * The default `getKey` function for `useScrollRestoration`.
- * It returns the `key` from the location state or the `href` of the location.
- *
- * The `location.href` is used as a fallback to support the use case where the location state is not available like the initial render.
- */
-export const defaultGetScrollRestorationKey = (location) => {
-    return location.state.key || location.href;
-};
-export function getCssSelector(el) {
-    const path = [];
-    let parent;
-    while ((parent = el.parentNode)) {
-        path.unshift(`${el.tagName}:nth-child(${[].indexOf.call(parent.children, el) + 1})`);
-        el = parent;
-    }
-    return `${path.join(' > ')}`.toLowerCase();
-}
-let ignoreScroll = false;
-// NOTE: This function must remain pure and not use any outside variables
-// unless they are passed in as arguments. Why? Because we need to be able to
-// toString() it into a script tag to execute as early as possible in the browser
-// during SSR. Additionally, we also call it from within the router lifecycle
-export function restoreScroll(storageKey, key, behavior, shouldScrollRestoration, scrollToTopSelectors) {
-    let byKey;
-    try {
-        byKey = JSON.parse(sessionStorage.getItem(storageKey) || '{}');
-    }
-    catch (error) {
-        console.error(error);
-        return;
-    }
-    const resolvedKey = key || window.history.state?.key;
-    const elementEntries = byKey[resolvedKey];
-    //
-    ignoreScroll = true;
-    (() => {
-        // If we have a cached entry for this location state,
-        // we always need to prefer that over the hash scroll.
-        if (shouldScrollRestoration && elementEntries) {
-            for (const elementSelector in elementEntries) {
-                const entry = elementEntries[elementSelector];
-                if (elementSelector === 'window') {
-                    window.scrollTo({
-                        top: entry.scrollY,
-                        left: entry.scrollX,
-                        behavior,
-                    });
-                }
-                else if (elementSelector) {
-                    const element = document.querySelector(elementSelector);
-                    if (element) {
-                        element.scrollLeft = entry.scrollX;
-                        element.scrollTop = entry.scrollY;
-                    }
-                }
-            }
-            return;
-        }
-        // If we don't have a cached entry for the hash,
-        // Which means we've never seen this location before,
-        // we need to check if there is a hash in the URL.
-        // If there is, we need to scroll it's ID into view.
-        const hash = window.location.hash.split('#')[1];
-        if (hash) {
-            const hashScrollIntoViewOptions = (window.history.state || {}).__hashScrollIntoViewOptions ?? true;
-            if (hashScrollIntoViewOptions) {
-                const el = document.getElementById(hash);
-                if (el) {
-                    el.scrollIntoView(hashScrollIntoViewOptions);
-                }
-            }
-            return;
-        }
-        // If there is no cached entry for the hash and there is no hash in the URL,
-        // we need to scroll to the top of the page for every scrollToTop element
-        ;
-        [
-            'window',
-            ...(scrollToTopSelectors?.filter((d) => d !== 'window') ?? []),
-        ].forEach((selector) => {
-            const element = selector === 'window' ? window : document.querySelector(selector);
-            if (element) {
-                element.scrollTo({
-                    top: 0,
-                    left: 0,
-                    behavior,
-                });
-            }
-        });
-    })();
-    //
-    ignoreScroll = false;
-}
-export function setupScrollRestoration(router, force) {
-    const shouldScrollRestoration = force ?? router.options.scrollRestoration ?? false;
-    if (shouldScrollRestoration) {
-        router.isScrollRestoring = true;
-    }
-    if (typeof document === 'undefined' || router.isScrollRestorationSetup) {
-        return;
-    }
-    router.isScrollRestorationSetup = true;
-    //
-    ignoreScroll = false;
-    const getKey = router.options.getScrollRestorationKey || defaultGetScrollRestorationKey;
-    window.history.scrollRestoration = 'manual';
-    // // Create a MutationObserver to monitor DOM changes
-    // const mutationObserver = new MutationObserver(() => {
-    //   ;ignoreScroll = true
-    //   requestAnimationFrame(() => {
-    //     ;ignoreScroll = false
-    //     // Attempt to restore scroll position on each dom
-    //     // mutation until the user scrolls. We do this
-    //     // because dynamic content may come in at different
-    //     // ticks after the initial render and we want to
-    //     // keep up with that content as much as possible.
-    //     // As soon as the user scrolls, we no longer need
-    //     // to attempt router.
-    //     // console.log('mutation observer restoreScroll')
-    //     restoreScroll(
-    //       storageKey,
-    //       getKey(router.state.location),
-    //       router.options.scrollRestorationBehavior,
-    //     )
-    //   })
-    // })
-    // const observeDom = () => {
-    //   // Observe changes to the entire document
-    //   mutationObserver.observe(document, {
-    //     childList: true, // Detect added or removed child nodes
-    //     subtree: true, // Monitor all descendants
-    //     characterData: true, // Detect text content changes
-    //   })
-    // }
-    // const unobserveDom = () => {
-    //   mutationObserver.disconnect()
-    // }
-    // observeDom()
-    const onScroll = (event) => {
-        // unobserveDom()
-        if (ignoreScroll || !router.isScrollRestoring) {
-            return;
-        }
-        let elementSelector = '';
-        if (event.target === document || event.target === window) {
-            elementSelector = 'window';
-        }
-        else {
-            const attrId = event.target.getAttribute('data-scroll-restoration-id');
-            if (attrId) {
-                elementSelector = `[data-scroll-restoration-id="${attrId}"]`;
-            }
-            else {
-                elementSelector = getCssSelector(event.target);
-            }
-        }
-        const restoreKey = getKey(router.state.location);
-        scrollRestorationCache.set((state) => {
-            const keyEntry = (state[restoreKey] =
-                state[restoreKey] || {});
-            const elementEntry = (keyEntry[elementSelector] =
-                keyEntry[elementSelector] || {});
-            if (elementSelector === 'window') {
-                elementEntry.scrollX = window.scrollX || 0;
-                elementEntry.scrollY = window.scrollY || 0;
-            }
-            else if (elementSelector) {
-                const element = document.querySelector(elementSelector);
-                if (element) {
-                    elementEntry.scrollX = element.scrollLeft || 0;
-                    elementEntry.scrollY = element.scrollTop || 0;
-                }
-            }
-            return state;
-        });
-    };
-    // Throttle the scroll event to avoid excessive updates
-    if (typeof document !== 'undefined') {
-        document.addEventListener('scroll', throttle(onScroll, 100), true);
-    }
-    router.subscribe('onRendered', (event) => {
-        // unobserveDom()
-        const cacheKey = getKey(event.toLocation);
-        // If the user doesn't want to restore the scroll position,
-        // we don't need to do anything.
-        if (!router.resetNextScroll) {
-            router.resetNextScroll = true;
-            return;
-        }
-        restoreScroll(storageKey, cacheKey, router.options.scrollRestorationBehavior || undefined, router.isScrollRestoring || undefined, router.options.scrollToTopSelectors || undefined);
-        if (router.isScrollRestoring) {
-            // Mark the location as having been seen
-            scrollRestorationCache.set((state) => {
-                state[cacheKey] = state[cacheKey] || {};
-                return state;
-            });
-        }
-    });
-}
 export function ScrollRestoration() {
     const router = useRouter();
     const getKey = router.options.getScrollRestorationKey || defaultGetScrollRestorationKey;

package/dist/source/scroll-restoration.jsx.map

@@ -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;AAuBzC,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,UAAkB,EAClB,GAAuB,EACvB,QAAiD,EACjD,uBAA4C,EAC5C,oBAA+C;IAE/C,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,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;QAE/C,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,UAAU,EACV,QAAQ,EACR,MAAM,CAAC,OAAO,CAAC,yBAAyB,IAAI,SAAS,EACrD,MAAM,CAAC,iBAAiB,IAAI,SAAS,EACrC,MAAM,CAAC,OAAO,CAAC,oBAAoB,IAAI,SAAS,CACjD,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"}
+{"version":3,"file":"scroll-restoration.jsx","sourceRoot":"","sources":["../../src/scroll-restoration.tsx"],"names":[],"mappings":"AAAA,OAAO,EACL,8BAA8B,EAC9B,aAAa,EACb,UAAU,GACX,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,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

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/solid-router",
-  "version": "1.114.14",
+  "version": "1.114.15",
   "description": "Modern and scalable routing for Solid applications",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -61,7 +61,7 @@
     "tiny-invariant": "^1.3.3",
     "tiny-warning": "^1.0.3",
     "@tanstack/history": "1.114.12",
-    "@tanstack/router-core": "1.114.12"
+    "@tanstack/router-core": "1.114.15"
   },
   "devDependencies": {
     "@solidjs/testing-library": "^0.8.10",

package/src/ScrollRestoration.tsx

@@ -1,12 +1,15 @@
-import { useRouter } from './useRouter'
 import {
   defaultGetScrollRestorationKey,
   getCssSelector,
   scrollRestorationCache,
   setupScrollRestoration,
-} from './scroll-restoration'
-import type { ScrollRestorationOptions } from './scroll-restoration'
-import type { ParsedLocation } from '@tanstack/router-core'
+} from '@tanstack/router-core'
+import { useRouter } from './useRouter'
+import type {
+  ParsedLocation,
+  ScrollRestorationEntry,
+  ScrollRestorationOptions,
+} from '@tanstack/router-core'
 
 function useScrollRestoration() {
   const router = useRouter()
@@ -41,7 +44,7 @@ export function useElementScrollRestoration(
   ) & {
     getKey?: (location: ParsedLocation) => string
   },
-) {
+): ScrollRestorationEntry | undefined {
   useScrollRestoration()
 
   const router = useRouter()

package/src/router.ts

@@ -25,11 +25,11 @@ import {
   replaceEqualDeep,
   resolvePath,
   rootRouteId,
+  setupScrollRestoration,
   trimPath,
   trimPathLeft,
   trimPathRight,
 } from '@tanstack/router-core'
-import { setupScrollRestoration } from './scroll-restoration'
 import type * as Solid from 'solid-js'
 import type { HistoryLocation, RouterHistory } from '@tanstack/history'
 

package/src/scroll-restoration.tsx

@@ -1,328 +1,11 @@
-import { functionalUpdate } from '@tanstack/router-core'
+import {
+  defaultGetScrollRestorationKey,
+  restoreScroll,
+  storageKey,
+} from '@tanstack/router-core'
 import { useRouter } from './useRouter'
 import { ScriptOnce } from './ScriptOnce'
 
-import type {
-  AnyRouter,
-  NonNullableUpdater,
-  ParsedLocation,
-} from '@tanstack/router-core'
-
-export type ScrollRestorationEntry = { scrollX: number; scrollY: number }
-
-export type ScrollRestorationByElement = Record<string, ScrollRestorationEntry>
-
-export type ScrollRestorationByKey = Record<string, ScrollRestorationByElement>
-
-export type ScrollRestorationCache = {
-  state: ScrollRestorationByKey
-  set: (updater: NonNullableUpdater<ScrollRestorationByKey>) => void
-}
-export type ScrollRestorationOptions = {
-  getKey?: (location: ParsedLocation) => string
-  scrollBehavior?: ScrollToOptions['behavior']
-}
-
-export const storageKey = 'tsr-scroll-restoration-v1_3'
-let sessionsStorage = false
-try {
-  sessionsStorage =
-    typeof window !== 'undefined' && typeof window.sessionStorage === 'object'
-} catch {}
-const throttle = (fn: (...args: Array<any>) => void, wait: number) => {
-  let timeout: any
-  return (...args: Array<any>) => {
-    if (!timeout) {
-      timeout = setTimeout(() => {
-        fn(...args)
-        timeout = null
-      }, wait)
-    }
-  }
-}
-export const scrollRestorationCache: ScrollRestorationCache = sessionsStorage
-  ? (() => {
-      const state: ScrollRestorationByKey =
-        JSON.parse(window.sessionStorage.getItem(storageKey) || 'null') || {}
-
-      return {
-        state,
-        // This setter is simply to make sure that we set the sessionStorage right
-        // after the state is updated. It doesn't necessarily need to be a functional
-        // update.
-        set: (updater) => (
-          (scrollRestorationCache.state =
-            // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-            functionalUpdate(updater, scrollRestorationCache.state) ||
-            scrollRestorationCache.state),
-          window.sessionStorage.setItem(
-            storageKey,
-            JSON.stringify(scrollRestorationCache.state),
-          )
-        ),
-      }
-    })()
-  : (undefined as any)
-/**
- * The default `getKey` function for `useScrollRestoration`.
- * It returns the `key` from the location state or the `href` of the location.
- *
- * The `location.href` is used as a fallback to support the use case where the location state is not available like the initial render.
- */
-
-export const defaultGetScrollRestorationKey = (location: ParsedLocation) => {
-  return location.state.key! || location.href
-}
-
-export function getCssSelector(el: any): string {
-  const path = []
-  let parent
-  while ((parent = el.parentNode)) {
-    path.unshift(
-      `${el.tagName}:nth-child(${([].indexOf as any).call(parent.children, el) + 1})`,
-    )
-    el = parent
-  }
-  return `${path.join(' > ')}`.toLowerCase()
-}
-
-let ignoreScroll = false
-
-// NOTE: This function must remain pure and not use any outside variables
-// unless they are passed in as arguments. Why? Because we need to be able to
-// toString() it into a script tag to execute as early as possible in the browser
-// during SSR. Additionally, we also call it from within the router lifecycle
-export function restoreScroll(
-  storageKey: string,
-  key: string | undefined,
-  behavior: ScrollToOptions['behavior'] | undefined,
-  shouldScrollRestoration: boolean | undefined,
-  scrollToTopSelectors: Array<string> | undefined,
-) {
-  let byKey: ScrollRestorationByKey
-
-  try {
-    byKey = JSON.parse(sessionStorage.getItem(storageKey) || '{}')
-  } catch (error: any) {
-    console.error(error)
-    return
-  }
-
-  const resolvedKey = key || window.history.state?.key
-  const elementEntries = byKey[resolvedKey]
-
-  //
-  ignoreScroll = true
-
-  //
-  ;(() => {
-    // If we have a cached entry for this location state,
-    // we always need to prefer that over the hash scroll.
-    if (shouldScrollRestoration && elementEntries) {
-      for (const elementSelector in elementEntries) {
-        const entry = elementEntries[elementSelector]!
-        if (elementSelector === 'window') {
-          window.scrollTo({
-            top: entry.scrollY,
-            left: entry.scrollX,
-            behavior,
-          })
-        } else if (elementSelector) {
-          const element = document.querySelector(elementSelector)
-          if (element) {
-            element.scrollLeft = entry.scrollX
-            element.scrollTop = entry.scrollY
-          }
-        }
-      }
-
-      return
-    }
-
-    // If we don't have a cached entry for the hash,
-    // Which means we've never seen this location before,
-    // we need to check if there is a hash in the URL.
-    // If there is, we need to scroll it's ID into view.
-    const hash = window.location.hash.split('#')[1]
-
-    if (hash) {
-      const hashScrollIntoViewOptions =
-        (window.history.state || {}).__hashScrollIntoViewOptions ?? true
-
-      if (hashScrollIntoViewOptions) {
-        const el = document.getElementById(hash)
-        if (el) {
-          el.scrollIntoView(hashScrollIntoViewOptions)
-        }
-      }
-
-      return
-    }
-
-    // If there is no cached entry for the hash and there is no hash in the URL,
-    // we need to scroll to the top of the page for every scrollToTop element
-    ;[
-      'window',
-      ...(scrollToTopSelectors?.filter((d) => d !== 'window') ?? []),
-    ].forEach((selector) => {
-      const element =
-        selector === 'window' ? window : document.querySelector(selector)
-      if (element) {
-        element.scrollTo({
-          top: 0,
-          left: 0,
-          behavior,
-        })
-      }
-    })
-  })()
-
-  //
-  ignoreScroll = false
-}
-
-export function setupScrollRestoration(router: AnyRouter, force?: boolean) {
-  const shouldScrollRestoration =
-    force ?? router.options.scrollRestoration ?? false
-
-  if (shouldScrollRestoration) {
-    router.isScrollRestoring = true
-  }
-
-  if (typeof document === 'undefined' || router.isScrollRestorationSetup) {
-    return
-  }
-
-  router.isScrollRestorationSetup = true
-
-  //
-  ignoreScroll = false
-
-  const getKey =
-    router.options.getScrollRestorationKey || defaultGetScrollRestorationKey
-
-  window.history.scrollRestoration = 'manual'
-
-  // // Create a MutationObserver to monitor DOM changes
-  // const mutationObserver = new MutationObserver(() => {
-  //   ;ignoreScroll = true
-  //   requestAnimationFrame(() => {
-  //     ;ignoreScroll = false
-
-  //     // Attempt to restore scroll position on each dom
-  //     // mutation until the user scrolls. We do this
-  //     // because dynamic content may come in at different
-  //     // ticks after the initial render and we want to
-  //     // keep up with that content as much as possible.
-  //     // As soon as the user scrolls, we no longer need
-  //     // to attempt router.
-  //     // console.log('mutation observer restoreScroll')
-  //     restoreScroll(
-  //       storageKey,
-  //       getKey(router.state.location),
-  //       router.options.scrollRestorationBehavior,
-  //     )
-  //   })
-  // })
-
-  // const observeDom = () => {
-  //   // Observe changes to the entire document
-  //   mutationObserver.observe(document, {
-  //     childList: true, // Detect added or removed child nodes
-  //     subtree: true, // Monitor all descendants
-  //     characterData: true, // Detect text content changes
-  //   })
-  // }
-
-  // const unobserveDom = () => {
-  //   mutationObserver.disconnect()
-  // }
-
-  // observeDom()
-
-  const onScroll = (event: Event) => {
-    // unobserveDom()
-
-    if (ignoreScroll || !router.isScrollRestoring) {
-      return
-    }
-
-    let elementSelector = ''
-
-    if (event.target === document || event.target === window) {
-      elementSelector = 'window'
-    } else {
-      const attrId = (event.target as Element).getAttribute(
-        'data-scroll-restoration-id',
-      )
-
-      if (attrId) {
-        elementSelector = `[data-scroll-restoration-id="${attrId}"]`
-      } else {
-        elementSelector = getCssSelector(event.target)
-      }
-    }
-
-    const restoreKey = getKey(router.state.location)
-
-    scrollRestorationCache.set((state) => {
-      const keyEntry = (state[restoreKey] =
-        state[restoreKey] || ({} as ScrollRestorationByElement))
-
-      const elementEntry = (keyEntry[elementSelector] =
-        keyEntry[elementSelector] || ({} as ScrollRestorationEntry))
-
-      if (elementSelector === 'window') {
-        elementEntry.scrollX = window.scrollX || 0
-        elementEntry.scrollY = window.scrollY || 0
-      } else if (elementSelector) {
-        const element = document.querySelector(elementSelector)
-        if (element) {
-          elementEntry.scrollX = element.scrollLeft || 0
-          elementEntry.scrollY = element.scrollTop || 0
-        }
-      }
-
-      return state
-    })
-  }
-
-  // Throttle the scroll event to avoid excessive updates
-  if (typeof document !== 'undefined') {
-    document.addEventListener('scroll', throttle(onScroll, 100), true)
-  }
-
-  router.subscribe('onRendered', (event) => {
-    // unobserveDom()
-
-    const cacheKey = getKey(event.toLocation)
-
-    // If the user doesn't want to restore the scroll position,
-    // we don't need to do anything.
-    if (!router.resetNextScroll) {
-      router.resetNextScroll = true
-      return
-    }
-
-    restoreScroll(
-      storageKey,
-      cacheKey,
-      router.options.scrollRestorationBehavior || undefined,
-      router.isScrollRestoring || undefined,
-      router.options.scrollToTopSelectors || undefined,
-    )
-
-    if (router.isScrollRestoring) {
-      // Mark the location as having been seen
-      scrollRestorationCache.set((state) => {
-        state[cacheKey] = state[cacheKey] || ({} as ScrollRestorationByElement)
-
-        return state
-      })
-    }
-  })
-}
-
 export function ScrollRestoration() {
   const router = useRouter()
   const getKey =