navgo 4.0.3 → 5.0.1

package/index.d.ts

@@ -86,6 +86,8 @@ export interface Options {
 	 *  scrolling lands on the correct elements.
 	 */
 	tick?: () => void | Promise<void>
+	/** When `false`, do not scroll to top on non-hash navigations. Default true. */
+	scroll_to_top?: boolean
 	/** Global hook fired whenever the URL changes.
 	 *  Triggers for shallow pushes/replaces, hash changes, popstate-shallow, 404s, and full navigations.
 	 *  Receives the router's current snapshot (eg `{ url: URL, route: RouteTuple|null, params: Params }`).

package/index.js

@@ -1,3 +1,4 @@
+import { throttle } from 'es-toolkit'
 import { parse } from 'regexparam'
 import { tick } from 'svelte'
 import { writable } from 'svelte/store'
@@ -14,6 +15,7 @@ export default class Navgo {
 		after_navigate: undefined,
 		url_changed: undefined,
 		tick,
+		scroll_to_top: true,
 		attach_to_window: true,
 	}
 	/** @type {Array<{ pattern: RegExp, keys: string[]|null, data: RouteTuple }>} */
@@ -138,7 +140,7 @@ export default class Navgo {
 				if (pos) {
 					scrollTo(pos.x, pos.y)
 					ℹ('[🧭 scroll]', 'restore hash-back', { idx: this.#route_idx, ...pos })
-				} else {
+				} else if (this.#opts.scroll_to_top) {
 					// no saved position for previous entry — default to top
 					scrollTo(0, 0)
 					ℹ('[🧭 scroll]', 'hash-back -> top')
@@ -254,8 +256,8 @@ export default class Navgo {
 		return true
 	}
 
-	async #run_loader(route, params) {
-		const ret_val = route[1].loader?.(params, route)
+	async #run_loader(route, url, params) {
+		const ret_val = route[1].loader?.({ route_entry: route, url, params })
 		return Array.isArray(ret_val) ? Promise.all(ret_val) : ret_val
 	}
 
@@ -355,7 +357,7 @@ export default class Navgo {
 			const pre = this.#preloads.get(path)
 			data =
 				pre?.data ??
-				(await (pre?.promise || this.#run_loader(hit.route, hit.params)).catch(e => ({
+				(await (pre?.promise || this.#run_loader(hit.route, url, hit.params)).catch(e => ({
 					__error: e,
 				})))
 			this.#preloads.delete(path)
@@ -482,7 +484,7 @@ export default class Navgo {
 	 */
 	/** @param {string} url_raw @returns {Promise<unknown|void>} */
 	async preload(url_raw) {
-		const { path } = this.#resolve_url_and_path(url_raw) || {}
+		const { path, url } = this.#resolve_url_and_path(url_raw) || {}
 		if (!path) {
 			ℹ('[🧭 preload]', 'invalid url', { url: url_raw })
 			return Promise.resolve()
@@ -505,7 +507,7 @@ export default class Navgo {
 		}
 
 		const entry = {}
-		entry.promise = this.#run_loader(hit.route, hit.params).then(data => {
+		entry.promise = this.#run_loader(hit.route, url, hit.params).then(data => {
 			entry.data = data
 			delete entry.promise
 			ℹ('[🧭 preload]', 'done', { path })
@@ -699,8 +701,10 @@ export default class Navgo {
 				return
 			}
 			// 3) Default: scroll to top for new navigations
-			scrollTo(0, 0)
-			ℹ('[🧭 scroll]', 'top')
+			if (this.#opts.scroll_to_top) {
+				scrollTo(0, 0)
+				ℹ('[🧭 scroll]', 'top')
+			}
 		})
 	}
 
@@ -736,27 +740,6 @@ export default class Navgo {
 	}
 }
 
-function throttle(fn, ms) {
-	let t,
-		last = 0
-	return e => {
-		const now = Date.now()
-		if (now - last >= ms) {
-			last = now
-			fn(e)
-		} else {
-			clearTimeout(t)
-			t = setTimeout(
-				() => {
-					last = Date.now()
-					fn(e)
-				},
-				ms - (now - last),
-			)
-		}
-	}
-}
-
 /** @typedef {import('./index.d.ts').Options} Options */
 /** @typedef {import('./index.d.ts').RouteTuple} RouteTuple */
 /** @typedef {import('./index.d.ts').MatchResult} MatchResult */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "navgo",
-	"version": "4.0.3",
+	"version": "5.0.1",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/mustafa0x/navgo.git"
@@ -32,6 +32,7 @@
 		"router"
 	],
 	"dependencies": {
+		"es-toolkit": "^1.42.0",
 		"regexparam": "^3.0.0"
 	},
 	"peerDependencies": {

package/readme.md

@@ -102,6 +102,8 @@ Notes:
   - App-level hook called after routing completes (URL updated, data loaded). `nav.to.data` holds any loader data.
 - `tick`: `() => void | Promise<void>`
   - Awaited after `after_navigate` and before scroll handling; useful for frameworks to flush DOM so anchor/top scrolling lands correctly.
+- `scroll_to_top`: `boolean` (default `true`)
+  - When `false`, skips the default top scroll for non-hash navigations.
 - `url_changed`: `(snapshot: any) => void`
   - Fires on every URL change -- shallow `push_state`/`replace_state`, hash changes, `popstate` shallow entries, 404s, and full navigations. (deprecated; subscribe to `.route` instead.)
   - Receives the router's current snapshot: an object like `{ url: URL, route: RouteTuple|null, params: Params }`.