Skip to content

refactor: Update names & types for nav handler to make it more clear #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 25, 2025
Merged

refactor: Update names & types for nav handler to make it more clear #99

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac5534a
refactor: Update names & types for nav handler to make it more clear
rschristian Jun 25, 2025
21f0fc4
refactor: Improve name, drop dead branch
rschristian Jun 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 34 additions & 17 deletions src/router.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,38 +7,53 @@ import { useContext, useMemo, useReducer, useLayoutEffect, useRef } from 'preact
* @typedef {import('./internal.d.ts').VNode} VNode
*/

let push, scope;
const UPDATE = (state, url) => {
/** @type {boolean} */
let push;
/** @type {string | RegExp | undefined} */
let scope;

/**
* @param {string} href
* @returns {boolean}
*/
function isInScope(href) {
return !scope || (typeof scope == 'string'
? href.startsWith(scope)
: scope.test(href)
);
}

/**
* @param {string} state
* @param {MouseEvent | PopStateEvent | { url: string, replace?: boolean }} action
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By no means does the following code pass TS's inspection, but it's at least easy to reason about. We can always sprinke in instanceof or prop in action checks later if really needed.

*/
function handleNav(state, action) {
let url = '';
push = undefined;
if (url && url.type === 'click') {
if (action && action.type === 'click') {
// ignore events the browser takes care of already:
if (url.ctrlKey || url.metaKey || url.altKey || url.shiftKey || url.button !== 0) {
if (action.ctrlKey || action.metaKey || action.altKey || action.shiftKey || action.button !== 0) {
return state;
}

const link = url.composedPath().find(el => el.nodeName == 'A' && el.href),
const link = action.composedPath().find(el => el.nodeName == 'A' && el.href),
href = link && link.getAttribute('href');
if (
!link ||
link.origin != location.origin ||
/^#/.test(href) ||
!/^(_?self)?$/i.test(link.target) ||
scope && (typeof scope == 'string'
? !href.startsWith(scope)
: !scope.test(href)
)
!isInScope(href)
) {
return state;
}

push = true;
url.preventDefault();
action.preventDefault();
url = link.href.replace(location.origin, '');
} else if (typeof url === 'string') {
push = true;
Comment on lines -37 to -38
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This branch has been dead since #8.

It used to support the route() function for programmatic nav, but with the addition of the replace parameter, that uses the form of handleNav({ url, replace }) -- it's no longer a singular string param.

} else if (url && url.url) {
push = !url.replace;
url = url.url;
} else if (action && action.url) {
push = !action.replace;
url = action.url;
} else {
url = location.pathname + location.search;
}
Expand Down Expand Up @@ -77,11 +92,13 @@ export const exec = (url, route, matches = {}) => {
};

/**
* @type {import('./router.d.ts').LocationProvider}
* @param {Object} props
* @param {string | RegExp} [props.scope]
* @param {import('preact').ComponentChildren} [props.children]
*/
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);
const [url, route] = useReducer(handleNav, props.url || location.pathname + location.search);
if (props.scope) scope = props.scope;
const wasPush = push === true;

Expand Down