refactor: Switch to scope

preactjs · Oct 16, 2024 · fe68b8e · fe68b8e
1 parent 8b04312
commit fe68b8e
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 12 deletions.
diff --git a/src/router.d.ts b/src/router.d.ts
@@ -1,7 +1,7 @@
 import { AnyComponent, FunctionComponent, VNode } from 'preact';
 
 export function LocationProvider(props: {
-	limit?: string | RegExp;
+	scope?: string | RegExp;
 	children?: VNode[];
 }): VNode;
 

diff --git a/src/router.js b/src/router.js
@@ -7,7 +7,7 @@ import { useContext, useMemo, useReducer, useLayoutEffect, useRef } from 'preact
  * @typedef {import('./internal.d.ts').VNode} VNode
  */
 
-let push, limit;
+let push, scope;
 const UPDATE = (state, url) => {
 	push = undefined;
 	if (url && url.type === 'click') {
@@ -23,9 +23,9 @@ const UPDATE = (state, url) => {
 			link.origin != location.origin ||
 			/^#/.test(href) ||
 			!/^(_?self)?$/i.test(link.target) ||
-			limit && (typeof limit == 'string'
-				? !href.startsWith(limit)
-				: !limit.test(href)
+			scope && (typeof scope == 'string'
+				? !href.startsWith(scope)
+				: !scope.test(href)
 			)
 		) {
 			return state;
@@ -75,9 +75,13 @@ export const exec = (url, route, matches) => {
 	return matches;
 };
 
+/**
+ * @type {import('./router.d.ts').LocationProvider}
+ */
 export function LocationProvider(props) {
+	// @ts-expect-error - props.url is not implemented correctly & will be removed in the future
 	const [url, route] = useReducer(UPDATE, props.url || location.pathname + location.search);
-	if (props.limit) limit = props.limit;
+	if (props.scope) scope = props.scope;
 	const wasPush = push === true;
 
 	const value = useMemo(() => {

diff --git a/test/router.test.js b/test/router.test.js
@@ -582,7 +582,7 @@ describe('Router', () => {
 		}
 	});
 
-	describe('intercepted VS external links with `limit`', () => {
+	describe('intercepted VS external links with `scope`', () => {
 		const shouldIntercept = ['/app', '/app/deeper'];
 		const shouldNavigate = ['/site', '/site/deeper'];
 
@@ -617,9 +617,9 @@ describe('Router', () => {
 			pushState.resetHistory();
 		});
 
-		it('should intercept clicks on links matching the `limit` props (string)', async () => {
+		it('should intercept clicks on links matching the `scope` props (string)', async () => {
 			render(
-				<LocationProvider limit="/app">
+				<LocationProvider scope="/app">
 					<Router>
 						<Route default />
 					</Router>
@@ -647,7 +647,7 @@ describe('Router', () => {
 
 		it('should allow default browser navigation for links not matching the `limit` props (string)', async () => {
 			render(
-				<LocationProvider limit="app">
+				<LocationProvider scope="app">
 					<Router>
 						<Route default />
 					</Router>
@@ -674,7 +674,7 @@ describe('Router', () => {
 
 		it('should intercept clicks on links matching the `limit` props (regex)', async () => {
 			render(
-				<LocationProvider limit={/^\/app/}>
+				<LocationProvider scope={/^\/app/}>
 					<Router>
 						<Route default />
 					</Router>
@@ -702,7 +702,7 @@ describe('Router', () => {
 
 		it('should allow default browser navigation for links not matching the `limit` props (regex)', async () => {
 			render(
-				<LocationProvider limit={/^\/app/}>
+				<LocationProvider scope={/^\/app/}>
 					<Router>
 						<Route default />
 					</Router>