1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
/*
This file is part of GNU Taler
(C) 2022-2024 Taler Systems S.A.
GNU Taler is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation; either version 3, or (at your option) any later version.
GNU Taler is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with
GNU Taler; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
*/
import { ComponentChildren, createContext, h, VNode } from "preact";
import { useContext, useEffect, useState } from "preact/hooks";
import {
AppLocation,
ObjectOf,
Location,
findMatch,
RouteDefinition,
LocationNotFound,
} from "../utils/route.js";
/**
*
* @author Sebastian Javier Marchano (sebasjm)
*/
export type Type = {
path: string;
params: Record<string, string[]>;
navigateTo: (path: AppLocation) => void;
// addNavigationListener: (listener: (path: string, params: Record<string, string>) => void) => (() => void);
};
// @ts-expect-error should not be used without provider
const Context = createContext<Type>(undefined);
export const useNavigationContext = (): Type => useContext(Context);
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function useCurrentLocation<T extends ObjectOf<RouteDefinition<any>>>(
pagesMap: T,
): Location<T> | LocationNotFound<T> {
const pageList = Object.keys(pagesMap as object) as Array<keyof T>;
const { path, params } = useNavigationContext();
return findMatch(pagesMap, pageList, path, params);
}
function getPathAndParamsFromWindow(): {
path: string;
params: Record<string, string[]>;
} {
const path =
typeof window !== "undefined" ? window.location.hash.substring(1) : "/";
const params: Record<string, string[]> = {};
if (typeof window !== "undefined") {
for (const [key, value] of new URLSearchParams(window.location.search)) {
if (!params[key]) {
params[key] = [];
}
params[key].push(value);
}
}
return { path, params };
}
const { path: initialPath, params: initialParams } =
getPathAndParamsFromWindow();
// there is a possibility that if the browser does a redirection
// (which doesn't go through navigatTo function) and that executed
// too early (before addEventListener runs) it won't be taking
// into account
const PopStateEventType = "popstate";
export const BrowserHashNavigationProvider = ({
children,
}: {
children: ComponentChildren;
}): VNode => {
const [{ path, params }, setState] = useState({
path: initialPath,
params: initialParams,
});
if (typeof window === "undefined") {
throw Error(
"Can't use BrowserHashNavigationProvider if there is no window object",
);
}
function navigateTo(path: string): void {
const { params } = getPathAndParamsFromWindow();
setState({ path, params });
window.location.href = path;
}
useEffect(() => {
function eventListener(): void {
setState(getPathAndParamsFromWindow());
}
window.addEventListener(PopStateEventType, eventListener);
return () => {
window.removeEventListener(PopStateEventType, eventListener);
};
}, []);
return h(Context.Provider, {
value: { path, params, navigateTo },
children,
});
};
|