aaex-file-router 1.7.5 → 1.8.0

package/README.md

@@ -2,8 +2,10 @@
 
 A file-based routing system for React projects that automatically generates routes from your file structure. Similar to Next.js App Router or Remix file conventions.
 
-## V. 1.7.5
-Removed the 404 and root layout support since it was implemented wrong and broke 
+## V. 1.8.0
+
+Added [useScroll hook](#useScroll) to help with page scroll after navigation
+
 ## Table of Contents
 
 - [Features](#features)
@@ -19,6 +21,7 @@ Removed the 404 and root layout support since it was implemented wrong and broke
 - [Import strategy](#import-strategy)
 - [Layouts](#layouts)
 - [FileLink component](#filelink-component)
+- [useScroll hook](#useScroll)
 - [Usage](#usage)
 - [Generated files](#generated-files)
 - [API Reference](#api-reference)
@@ -288,9 +291,6 @@ All routes in `src/pages/dashboard/*` will render inside this layout.
 
 ---
 
-Top-level pages are always statically imported for faster initial navigation.
-All nested pages are lazy-loaded and wrapped in a Suspense boundary.
-
 ## FileLink component
 
 The FileLink component is a type safe wrapper for the Link component in react router that uses an autogenerated type to check which routes are available.
@@ -322,7 +322,6 @@ export default function Home() {
   return (
     <>
       Hello Home!
-      {/* FileRoutes is optional and not required it will work fine with any string if not passed */}
       <FileLink<FileRoutes> to="test">Test safe</FileLink>
       {/* or without type safety */}
       <FileLink to="some-route">Non safe</FileLink>
@@ -331,6 +330,73 @@ export default function Home() {
 }
 ```
 
+## useScroll
+
+Custom React hook that scrolls to the top after navigation.
+Designed to work seamlessly with client-side routing while remaining SSR-safe.
+
+### Features
+
+- Automatically scrolls on route change
+
+- Supports smooth scrolling
+
+- Can scroll either the window or a specific container
+
+- Safe to use in SSR environments
+
+### Usage
+
+```tsx
+import { useScroll } from "aaex-file-router";
+
+export default function PageWithNavigation() {
+  useScroll();
+
+  return <>{/* rest of content */}</>;
+}
+```
+
+### Options
+
+`useScroll` accepts an optional config object.
+
+```tsx
+useScroll({
+  behavior?: ScrollBehavior;
+  container?: HTMLElement | null;
+});
+```
+
+| Option      | Type                  | Default    | Description                              |
+| ----------- | --------------------- | ---------- | ---------------------------------------- | ------------------------- |
+| `behavior`  | `"auto"`              | `"smooth"` | `"auto"`                                 | Scroll animation behavior |
+| `container` | `HTMLElement \| null` | `null`     | Scrolls this element instead of `window` |
+
+### Example: smooth scroll
+
+```tsx
+useScroll({
+  behavior: "smooth",
+});
+```
+
+### Example: scroll a container
+
+```tsx
+const ref = useRef<HTMLDivElement>(null);
+
+useScroll({
+  container: ref.current,
+});
+
+return <div ref={ref}>...</div>;
+```
+
+---
+
+<br/>
+
 ## Generated files
 
 ### routes.ts

package/dist/hooks/useScroll.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Scrolls the window or a container to the top on route change
+ */
+export declare function useScroll(options?: {
+    behavior?: ScrollBehavior;
+    container?: HTMLElement | null;
+}): void;
+//# sourceMappingURL=useScroll.d.ts.map

package/dist/hooks/useScroll.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useScroll.d.ts","sourceRoot":"","sources":["../../src/hooks/useScroll.tsx"],"names":[],"mappings":"AAGA;;GAEG;AACH,wBAAgB,SAAS,CAAC,OAAO,CAAC,EAAE;IAClC,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,SAAS,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CAChC,QAaA"}

package/dist/hooks/useScroll.js

@@ -0,0 +1,19 @@
+import { useEffect } from "react";
+import { useLocation } from "react-router-dom";
+/**
+ * Scrolls the window or a container to the top on route change
+ */
+export function useScroll(options) {
+    const { pathname } = useLocation();
+    const behavior = options?.behavior ?? "auto";
+    const container = options?.container ?? null;
+    useEffect(() => {
+        if (container) {
+            container.scrollTo({ top: 0, behavior });
+        }
+        else {
+            window.scrollTo({ top: 0, behavior });
+        }
+    }, [pathname, behavior, container]);
+}
+//# sourceMappingURL=useScroll.js.map

package/dist/hooks/useScroll.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useScroll.js","sourceRoot":"","sources":["../../src/hooks/useScroll.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;GAEG;AACH,MAAM,UAAU,SAAS,CAAC,OAGzB;IACC,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,EAAE,CAAC;IAEnC,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,MAAM,CAAC;IAC7C,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,IAAI,CAAC;IAE7C,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,SAAS,EAAE,CAAC;YACd,SAAS,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC3C,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QACxC,CAAC;IACH,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;AACtC,CAAC"}

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export { FileLink } from "./components/FileLink.js";
+export { useScroll } from "./hooks/useScroll.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,0BAA0B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/index.js

@@ -1,2 +1,3 @@
 export { FileLink } from "./components/FileLink.js";
+export { useScroll } from "./hooks/useScroll.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,0BAA0B,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aaex-file-router",
-  "version": "1.7.5",
+  "version": "1.8.0",
   "description": "A file-based routing system for React projects that automatically generates routes from your file structure. Similar to Next.js App Router or Remix file conventions.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",