@real-router/solid 0.5.2 → 0.6.0

package/README.md

@@ -320,11 +320,23 @@ Enable screen reader announcements for route changes:
 
 When enabled, a visually hidden `aria-live` region announces each navigation. Focus moves to the first `<h1>` on the new page. See [Accessibility guide](https://github.com/greydragon888/real-router/wiki/Accessibility) for details.
 
+## Scroll Restoration
+
+Opt-in preservation of scroll position across navigations:
+
+```tsx
+<RouterProvider router={router} scrollRestoration={{ mode: "restore" }}>
+  {/* Your app */}
+</RouterProvider>
+```
+
+Restores scroll on back/forward, scrolls to top (or `#hash`) on push. Three modes: `"restore"` (default), `"top"`, `"manual"`. Custom containers via `scrollContainer: () => HTMLElement | null`. Options are read once on mount — changing the prop at runtime does not reconfigure the utility (Solid `onMount` is non-reactive). See [Scroll Restoration guide](https://github.com/greydragon888/real-router/wiki/Scroll-Restoration) for details.
+
 ## Documentation
 
 Full documentation: [Wiki](https://github.com/greydragon888/real-router/wiki)
 
-- [RouterProvider](https://github.com/greydragon888/real-router/wiki/RouterProvider) · [RouteView](https://github.com/greydragon888/real-router/wiki/RouteView) · [RouterErrorBoundary](https://github.com/greydragon888/real-router/wiki/RouterErrorBoundary) · [Link](https://github.com/greydragon888/real-router/wiki/Link)
+- [RouterProvider](https://github.com/greydragon888/real-router/wiki/RouterProvider) · [RouteView](https://github.com/greydragon888/real-router/wiki/RouteView) · [RouterErrorBoundary](https://github.com/greydragon888/real-router/wiki/RouterErrorBoundary) · [Link](https://github.com/greydragon888/real-router/wiki/Link) · [Scroll Restoration](https://github.com/greydragon888/real-router/wiki/Scroll-Restoration)
 - [useRouter](https://github.com/greydragon888/real-router/wiki/useRouter) · [useRoute](https://github.com/greydragon888/real-router/wiki/useRoute) · [useRouteNode](https://github.com/greydragon888/real-router/wiki/useRouteNode) · [useNavigator](https://github.com/greydragon888/real-router/wiki/useNavigator) · [useRouteUtils](https://github.com/greydragon888/real-router/wiki/useRouteUtils) · [useRouterTransition](https://github.com/greydragon888/real-router/wiki/useRouterTransition)
 
 ## Examples

package/dist/cjs/index.d.ts

@@ -89,9 +89,17 @@ declare function useRouteNodeStore(nodeName: string): RouteState;
 
 declare function useRouterTransition(): Accessor<RouterTransitionSnapshot>;
 
+type ScrollRestorationMode = "restore" | "top" | "manual";
+interface ScrollRestorationOptions {
+    mode?: ScrollRestorationMode | undefined;
+    anchorScrolling?: boolean | undefined;
+    scrollContainer?: (() => HTMLElement | null) | undefined;
+}
+
 interface RouteProviderProps {
     router: Router;
     announceNavigation?: boolean;
+    scrollRestoration?: ScrollRestorationOptions;
 }
 declare function RouterProvider(props: ParentProps<RouteProviderProps>): JSX.Element;
 

package/dist/cjs/index.js

@@ -284,6 +284,163 @@ function manageFocus(h1) {
   });
 }
 
+const STORAGE_KEY = "real-router:scroll";
+const NOOP_INSTANCE = Object.freeze({
+  destroy: () => {
+    /* no-op */
+  }
+});
+function createScrollRestoration(router, options) {
+  if (typeof globalThis.window === "undefined") {
+    return NOOP_INSTANCE;
+  }
+  const mode = options?.mode ?? "restore";
+
+  // mode "manual" = utility does nothing. Don't flip history.scrollRestoration,
+  // don't subscribe, don't register pagehide — leave the browser's native
+  // auto-restore intact for the app to override if it wants to.
+  if (mode === "manual") {
+    return NOOP_INSTANCE;
+  }
+  const anchorEnabled = options?.anchorScrolling ?? true;
+  const getContainer = options?.scrollContainer;
+  const prevScrollRestoration = history.scrollRestoration;
+  try {
+    history.scrollRestoration = "manual";
+  } catch {
+    // Ignore — some embedded contexts may reject the assignment.
+  }
+
+  // Resolve the container lazily on every event so containers mounted AFTER
+  // the provider still get correct scroll handling. Falls back to window when
+  // the getter is absent or returns null (pre-mount).
+  const readPos = () => {
+    const element = getContainer?.();
+    return element ? element.scrollTop : globalThis.scrollY;
+  };
+  const writePos = top => {
+    const element = getContainer?.();
+    if (element) {
+      element.scrollTop = top;
+    } else {
+      globalThis.scrollTo(0, top);
+    }
+  };
+  const scrollToHashOrTop = () => {
+    const hash = globalThis.location.hash;
+    if (anchorEnabled && hash.length > 1) {
+      // location.hash is percent-encoded; ids in the DOM are the raw string.
+      // Decode for the match. Fall back to the raw slice if the hash contains
+      // a malformed escape sequence (decodeURIComponent throws on those).
+      let id;
+      try {
+        id = decodeURIComponent(hash.slice(1));
+      } catch {
+        id = hash.slice(1);
+      }
+
+      // eslint-disable-next-line unicorn/prefer-query-selector -- ids may contain CSS-unsafe chars
+      const element = document.getElementById(id);
+      if (element) {
+        element.scrollIntoView();
+        return;
+      }
+    }
+    writePos(0);
+  };
+  let destroyed = false;
+  const unsubscribe = router.subscribe(({
+    route,
+    previousRoute
+  }) => {
+    const nav = route.context.navigation;
+
+    // Browsers dispatch reload as the initial navigation after refresh, so
+    // previousRoute is undefined and capture is naturally skipped. The
+    // pre-refresh position was already persisted via pagehide.
+    if (previousRoute) {
+      putPos(keyOf(previousRoute), readPos());
+    }
+
+    // Single rAF so DOM is committed before we read anchors / write scroll.
+    // Guard against destroy() racing with the callback.
+    requestAnimationFrame(() => {
+      if (destroyed) {
+        return;
+      }
+      if (mode === "top" || !nav) {
+        scrollToHashOrTop();
+        return;
+      }
+      if (nav.navigationType === "replace") {
+        return;
+      }
+      if (nav.direction === "back" || nav.navigationType === "traverse" || nav.navigationType === "reload") {
+        writePos(loadStore()[keyOf(route)] ?? 0);
+        return;
+      }
+      scrollToHashOrTop();
+    });
+  });
+  const onPageHide = () => {
+    const current = router.getState();
+    if (current) {
+      putPos(keyOf(current), readPos());
+    }
+  };
+  globalThis.addEventListener("pagehide", onPageHide);
+  return {
+    destroy: () => {
+      if (destroyed) {
+        return;
+      }
+      destroyed = true;
+      unsubscribe();
+      globalThis.removeEventListener("pagehide", onPageHide);
+      try {
+        history.scrollRestoration = prevScrollRestoration;
+      } catch {
+        // Ignore.
+      }
+    }
+  };
+}
+function keyOf(state) {
+  return `${state.name}:${canonicalJson(state.params)}`;
+}
+function loadStore() {
+  try {
+    const raw = sessionStorage.getItem(STORAGE_KEY);
+    return raw ? JSON.parse(raw) : {};
+  } catch {
+    return {};
+  }
+}
+function putPos(key, pos) {
+  try {
+    const store = loadStore();
+    store[key] = pos;
+    sessionStorage.setItem(STORAGE_KEY, JSON.stringify(store));
+  } catch {
+    // Ignore quota / security errors.
+  }
+}
+function canonicalJson(value) {
+  return JSON.stringify(value, canonicalReplacer);
+}
+function canonicalReplacer(_key, val) {
+  if (val !== null && typeof val === "object" && !Array.isArray(val)) {
+    const sorted = {};
+    // eslint-disable-next-line unicorn/no-array-sort -- ng-packagr uses pre-ES2023 lib; toSorted unavailable
+    const keys = Object.keys(val).sort((left, right) => left.localeCompare(right));
+    for (const key of keys) {
+      sorted[key] = val[key];
+    }
+    return sorted;
+  }
+  return val;
+}
+
 function shouldNavigate(evt) {
   return evt.button === 0 && !evt.metaKey && !evt.altKey && !evt.ctrlKey && !evt.shiftKey;
 }
@@ -514,6 +671,15 @@ function RouterProvider(props) {
       announcer.destroy();
     });
   });
+  solidJs.onMount(() => {
+    if (!props.scrollRestoration) {
+      return;
+    }
+    const sr = createScrollRestoration(props.router, props.scrollRestoration);
+    solidJs.onCleanup(() => {
+      sr.destroy();
+    });
+  });
   const navigator = core.getNavigator(props.router);
   const routeSource = sources.createRouteSource(props.router);
   const routeSignal = createSignalFromSource(routeSource);

package/dist/esm/index.d.mts

@@ -89,9 +89,17 @@ declare function useRouteNodeStore(nodeName: string): RouteState;
 
 declare function useRouterTransition(): Accessor<RouterTransitionSnapshot>;
 
+type ScrollRestorationMode = "restore" | "top" | "manual";
+interface ScrollRestorationOptions {
+    mode?: ScrollRestorationMode | undefined;
+    anchorScrolling?: boolean | undefined;
+    scrollContainer?: (() => HTMLElement | null) | undefined;
+}
+
 interface RouteProviderProps {
     router: Router;
     announceNavigation?: boolean;
+    scrollRestoration?: ScrollRestorationOptions;
 }
 declare function RouterProvider(props: ParentProps<RouteProviderProps>): JSX.Element;
 

package/dist/esm/index.mjs

@@ -282,6 +282,163 @@ function manageFocus(h1) {
   });
 }
 
+const STORAGE_KEY = "real-router:scroll";
+const NOOP_INSTANCE = Object.freeze({
+  destroy: () => {
+    /* no-op */
+  }
+});
+function createScrollRestoration(router, options) {
+  if (typeof globalThis.window === "undefined") {
+    return NOOP_INSTANCE;
+  }
+  const mode = options?.mode ?? "restore";
+
+  // mode "manual" = utility does nothing. Don't flip history.scrollRestoration,
+  // don't subscribe, don't register pagehide — leave the browser's native
+  // auto-restore intact for the app to override if it wants to.
+  if (mode === "manual") {
+    return NOOP_INSTANCE;
+  }
+  const anchorEnabled = options?.anchorScrolling ?? true;
+  const getContainer = options?.scrollContainer;
+  const prevScrollRestoration = history.scrollRestoration;
+  try {
+    history.scrollRestoration = "manual";
+  } catch {
+    // Ignore — some embedded contexts may reject the assignment.
+  }
+
+  // Resolve the container lazily on every event so containers mounted AFTER
+  // the provider still get correct scroll handling. Falls back to window when
+  // the getter is absent or returns null (pre-mount).
+  const readPos = () => {
+    const element = getContainer?.();
+    return element ? element.scrollTop : globalThis.scrollY;
+  };
+  const writePos = top => {
+    const element = getContainer?.();
+    if (element) {
+      element.scrollTop = top;
+    } else {
+      globalThis.scrollTo(0, top);
+    }
+  };
+  const scrollToHashOrTop = () => {
+    const hash = globalThis.location.hash;
+    if (anchorEnabled && hash.length > 1) {
+      // location.hash is percent-encoded; ids in the DOM are the raw string.
+      // Decode for the match. Fall back to the raw slice if the hash contains
+      // a malformed escape sequence (decodeURIComponent throws on those).
+      let id;
+      try {
+        id = decodeURIComponent(hash.slice(1));
+      } catch {
+        id = hash.slice(1);
+      }
+
+      // eslint-disable-next-line unicorn/prefer-query-selector -- ids may contain CSS-unsafe chars
+      const element = document.getElementById(id);
+      if (element) {
+        element.scrollIntoView();
+        return;
+      }
+    }
+    writePos(0);
+  };
+  let destroyed = false;
+  const unsubscribe = router.subscribe(({
+    route,
+    previousRoute
+  }) => {
+    const nav = route.context.navigation;
+
+    // Browsers dispatch reload as the initial navigation after refresh, so
+    // previousRoute is undefined and capture is naturally skipped. The
+    // pre-refresh position was already persisted via pagehide.
+    if (previousRoute) {
+      putPos(keyOf(previousRoute), readPos());
+    }
+
+    // Single rAF so DOM is committed before we read anchors / write scroll.
+    // Guard against destroy() racing with the callback.
+    requestAnimationFrame(() => {
+      if (destroyed) {
+        return;
+      }
+      if (mode === "top" || !nav) {
+        scrollToHashOrTop();
+        return;
+      }
+      if (nav.navigationType === "replace") {
+        return;
+      }
+      if (nav.direction === "back" || nav.navigationType === "traverse" || nav.navigationType === "reload") {
+        writePos(loadStore()[keyOf(route)] ?? 0);
+        return;
+      }
+      scrollToHashOrTop();
+    });
+  });
+  const onPageHide = () => {
+    const current = router.getState();
+    if (current) {
+      putPos(keyOf(current), readPos());
+    }
+  };
+  globalThis.addEventListener("pagehide", onPageHide);
+  return {
+    destroy: () => {
+      if (destroyed) {
+        return;
+      }
+      destroyed = true;
+      unsubscribe();
+      globalThis.removeEventListener("pagehide", onPageHide);
+      try {
+        history.scrollRestoration = prevScrollRestoration;
+      } catch {
+        // Ignore.
+      }
+    }
+  };
+}
+function keyOf(state) {
+  return `${state.name}:${canonicalJson(state.params)}`;
+}
+function loadStore() {
+  try {
+    const raw = sessionStorage.getItem(STORAGE_KEY);
+    return raw ? JSON.parse(raw) : {};
+  } catch {
+    return {};
+  }
+}
+function putPos(key, pos) {
+  try {
+    const store = loadStore();
+    store[key] = pos;
+    sessionStorage.setItem(STORAGE_KEY, JSON.stringify(store));
+  } catch {
+    // Ignore quota / security errors.
+  }
+}
+function canonicalJson(value) {
+  return JSON.stringify(value, canonicalReplacer);
+}
+function canonicalReplacer(_key, val) {
+  if (val !== null && typeof val === "object" && !Array.isArray(val)) {
+    const sorted = {};
+    // eslint-disable-next-line unicorn/no-array-sort -- ng-packagr uses pre-ES2023 lib; toSorted unavailable
+    const keys = Object.keys(val).sort((left, right) => left.localeCompare(right));
+    for (const key of keys) {
+      sorted[key] = val[key];
+    }
+    return sorted;
+  }
+  return val;
+}
+
 function shouldNavigate(evt) {
   return evt.button === 0 && !evt.metaKey && !evt.altKey && !evt.ctrlKey && !evt.shiftKey;
 }
@@ -512,6 +669,15 @@ function RouterProvider(props) {
       announcer.destroy();
     });
   });
+  onMount(() => {
+    if (!props.scrollRestoration) {
+      return;
+    }
+    const sr = createScrollRestoration(props.router, props.scrollRestoration);
+    onCleanup(() => {
+      sr.destroy();
+    });
+  });
   const navigator = getNavigator(props.router);
   const routeSource = createRouteSource(props.router);
   const routeSignal = createSignalFromSource(routeSource);

package/dist/types/RouterProvider.d.ts

@@ -1,8 +1,10 @@
+import type { ScrollRestorationOptions } from "./dom-utils";
 import type { Router } from "@real-router/core";
 import type { ParentProps, JSX } from "solid-js";
 export interface RouteProviderProps {
     router: Router;
     announceNavigation?: boolean;
+    scrollRestoration?: ScrollRestorationOptions;
 }
 export declare function isRouteActive(linkRouteName: string, currentRouteName: string): boolean;
 export declare function RouterProvider(props: ParentProps<RouteProviderProps>): JSX.Element;

package/dist/types/RouterProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RouterProvider.d.ts","sourceRoot":"","sources":["../../src/RouterProvider.tsx"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAEjD,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,wBAAgB,aAAa,CAC3B,aAAa,EAAE,MAAM,EACrB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAKT;AAED,wBAAgB,cAAc,CAC5B,KAAK,EAAE,WAAW,CAAC,kBAAkB,CAAC,GACrC,GAAG,CAAC,OAAO,CA+Bb"}
+{"version":3,"file":"RouterProvider.d.ts","sourceRoot":"","sources":["../../src/RouterProvider.tsx"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAC5D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAEjD,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,iBAAiB,CAAC,EAAE,wBAAwB,CAAC;CAC9C;AAED,wBAAgB,aAAa,CAC3B,aAAa,EAAE,MAAM,EACrB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAKT;AAED,wBAAgB,cAAc,CAC5B,KAAK,EAAE,WAAW,CAAC,kBAAkB,CAAC,GACrC,GAAG,CAAC,OAAO,CA2Cb"}

package/dist/types/components/Link.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Link.d.ts","sourceRoot":"","sources":["../../../src/components/Link.tsx"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAEpC,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAC5C,KAAK,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAC5B,GAAG,CAAC,OAAO,CAoFb"}
+{"version":3,"file":"Link.d.ts","sourceRoot":"","sources":["../../../src/components/Link.tsx"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAEpC,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAC5C,KAAK,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAC5B,GAAG,CAAC,OAAO,CAoFb"}

package/dist/types/directives/link.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"link.d.ts","sourceRoot":"","sources":["../../../src/directives/link.tsx"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAC7D,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,CAAC,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAC5C,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,MAAM,oBAAoB,CAAC,CAAC,CAAC,GACtC,IAAI,CA+DN"}
+{"version":3,"file":"link.d.ts","sourceRoot":"","sources":["../../../src/directives/link.tsx"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAC7D,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,CAAC,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAC5C,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,MAAM,oBAAoB,CAAC,CAAC,CAAC,GACtC,IAAI,CA+DN"}

package/dist/types/dom-utils/index.d.ts

@@ -1,4 +1,6 @@
 export { createRouteAnnouncer } from "./route-announcer.js";
+export { createScrollRestoration } from "./scroll-restore.js";
 export { shouldNavigate, buildHref, buildActiveClassName, shallowEqual, applyLinkA11y, } from "./link-utils.js";
 export type { RouteAnnouncerOptions } from "./route-announcer.js";
+export type { ScrollRestorationOptions, ScrollRestorationMode, } from "./scroll-restore.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/dom-utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/dom-utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAE5D,OAAO,EACL,cAAc,EACd,SAAS,EACT,oBAAoB,EACpB,YAAY,EACZ,aAAa,GACd,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/dom-utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAE5D,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAE9D,OAAO,EACL,cAAc,EACd,SAAS,EACT,oBAAoB,EACpB,YAAY,EACZ,aAAa,GACd,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAElE,YAAY,EACV,wBAAwB,EACxB,qBAAqB,GACtB,MAAM,qBAAqB,CAAC"}

package/dist/types/dom-utils/scroll-restore.d.ts

@@ -0,0 +1,11 @@
+import type { Router } from "@real-router/core";
+export type ScrollRestorationMode = "restore" | "top" | "manual";
+export interface ScrollRestorationOptions {
+    mode?: ScrollRestorationMode | undefined;
+    anchorScrolling?: boolean | undefined;
+    scrollContainer?: (() => HTMLElement | null) | undefined;
+}
+export declare function createScrollRestoration(router: Router, options?: ScrollRestorationOptions): {
+    destroy: () => void;
+};
+//# sourceMappingURL=scroll-restore.d.ts.map

package/dist/types/dom-utils/scroll-restore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scroll-restore.d.ts","sourceRoot":"","sources":["../../../src/dom-utils/scroll-restore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAS,MAAM,mBAAmB,CAAC;AAUvD,MAAM,MAAM,qBAAqB,GAAG,SAAS,GAAG,KAAK,GAAG,QAAQ,CAAC;AAEjE,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;IACzC,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,eAAe,CAAC,EAAE,CAAC,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;CAC1D;AAOD,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,wBAAwB,GACjC;IAAE,OAAO,EAAE,MAAM,IAAI,CAAA;CAAE,CA+IzB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@real-router/solid",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "type": "commonjs",
   "description": "Solid.js integration for Real-Router",
   "main": "./dist/cjs/index.js",

package/src/RouterProvider.tsx

@@ -4,14 +4,16 @@ import { createSelector, onCleanup, onMount } from "solid-js";
 
 import { RouterContext, RouteContext } from "./context";
 import { createSignalFromSource } from "./createSignalFromSource";
-import { createRouteAnnouncer } from "./dom-utils/index.js";
+import { createRouteAnnouncer, createScrollRestoration } from "./dom-utils";
 
+import type { ScrollRestorationOptions } from "./dom-utils";
 import type { Router } from "@real-router/core";
 import type { ParentProps, JSX } from "solid-js";
 
 export interface RouteProviderProps {
   router: Router;
   announceNavigation?: boolean;
+  scrollRestoration?: ScrollRestorationOptions;
 }
 
 export function isRouteActive(
@@ -39,6 +41,18 @@ export function RouterProvider(
     });
   });
 
+  onMount(() => {
+    if (!props.scrollRestoration) {
+      return;
+    }
+
+    const sr = createScrollRestoration(props.router, props.scrollRestoration);
+
+    onCleanup(() => {
+      sr.destroy();
+    });
+  });
+
   const navigator = getNavigator(props.router);
   const routeSource = createRouteSource(props.router);
   const routeSignal = createSignalFromSource(routeSource);

package/src/components/Link.tsx

@@ -4,11 +4,7 @@ import { createMemo, mergeProps, splitProps, useContext } from "solid-js";
 import { EMPTY_PARAMS, EMPTY_OPTIONS } from "../constants";
 import { RouterContext } from "../context";
 import { createSignalFromSource } from "../createSignalFromSource";
-import {
-  shouldNavigate,
-  buildHref,
-  buildActiveClassName,
-} from "../dom-utils/index.js";
+import { shouldNavigate, buildHref, buildActiveClassName } from "../dom-utils";
 
 import type { LinkProps } from "../types";
 import type { Params } from "@real-router/core";

package/src/directives/link.tsx

@@ -3,11 +3,7 @@ import { createEffect, onCleanup } from "solid-js";
 
 import { EMPTY_PARAMS, EMPTY_OPTIONS } from "../constants";
 import { createSignalFromSource } from "../createSignalFromSource";
-import {
-  shouldNavigate,
-  applyLinkA11y,
-  buildHref,
-} from "../dom-utils/index.js";
+import { shouldNavigate, applyLinkA11y, buildHref } from "../dom-utils";
 import { useRouter } from "../hooks/useRouter";
 
 import type { Params } from "@real-router/core";