simon | 1170c32 | 2022-10-31 14:51:31 -0400 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2022 Savoir-faire Linux Inc. |
| 3 | * |
| 4 | * This program is free software; you can redistribute it and/or modify |
| 5 | * it under the terms of the GNU Affero General Public License as |
| 6 | * published by the Free Software Foundation; either version 3 of the |
| 7 | * License, or (at your option) any later version. |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU Affero General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU Affero General Public |
| 15 | * License along with this program. If not, see |
| 16 | * <https://www.gnu.org/licenses/>. |
| 17 | */ |
| 18 | import { useMemo } from 'react'; |
| 19 | import { useLocation, useParams } from 'react-router-dom'; |
| 20 | |
simon | ff1cb35 | 2022-11-24 15:15:26 -0500 | [diff] [blame] | 21 | export type RouteParams<UrlParams = Record<string, string>, QueryParams = Record<string, string>, State = any> = { |
| 22 | urlParams: UrlParams; |
| 23 | queryParams: QueryParams; |
| 24 | state?: State; |
simon | f929a36 | 2022-11-18 16:53:45 -0500 | [diff] [blame] | 25 | }; |
simon | 1170c32 | 2022-10-31 14:51:31 -0400 | [diff] [blame] | 26 | |
| 27 | export const useUrlParams = <T extends RouteParams>() => { |
simon | ff1cb35 | 2022-11-24 15:15:26 -0500 | [diff] [blame] | 28 | const { search, state } = useLocation(); |
simon | 1170c32 | 2022-10-31 14:51:31 -0400 | [diff] [blame] | 29 | const urlParams = useParams() as T['urlParams']; |
| 30 | |
| 31 | return useMemo(() => { |
| 32 | const queryParams = Object.fromEntries(new URLSearchParams(search)) as T['queryParams']; |
| 33 | return { |
| 34 | queryParams, |
| 35 | urlParams, |
simon | ff1cb35 | 2022-11-24 15:15:26 -0500 | [diff] [blame] | 36 | state: state as T['state'], |
simon | 1170c32 | 2022-10-31 14:51:31 -0400 | [diff] [blame] | 37 | }; |
simon | ff1cb35 | 2022-11-24 15:15:26 -0500 | [diff] [blame] | 38 | }, [search, urlParams, state]); |
simon | 1170c32 | 2022-10-31 14:51:31 -0400 | [diff] [blame] | 39 | }; |