File size: 2,450 Bytes
1e92f2d |
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 |
/* eslint-disable no-unused-vars */
import pick from 'lodash/pick.js'
import { parse, stringify } from 'qs'
import { useMemo } from 'react'
import { useLocation, useSearchParams } from 'react-router-dom'
// eslint-disable-next-line no-shadow
export enum QueryParams {
Tab = 'tab',
Redirect = 'redirectUrl',
Refresh = 'refresh',
}
// eslint-disable-next-line no-shadow
export enum QueryListParams {
Page = 'page',
SortBy = 'sortBy',
Direction = 'direction',
Filters = 'filters',
Query = 'query',
}
type Params<ParamsT = Record<string, unknown>, FiltersT = Record<string, unknown>> = ParamsT & {
sortBy: string
page: string
tab: string
redirectUrl: string
direction: 'asc' | 'desc'
filters: FiltersT
refresh: boolean
}
export function useQueryParams<
ParamsT = Record<string, unknown>,
FiltersT = Record<string, unknown>,
>() {
const { pathname } = useLocation()
const [searchParams, setSearchParams] = useSearchParams()
const parsedQuery = useMemo(
() => parse(searchParams.toString(), {
allowDots: true,
}) as unknown as Params<ParamsT, FiltersT>,
[searchParams, pathname],
)
const { sortBy, direction, page, tab, filters, redirectUrl } = parsedQuery
const listParams = useMemo(
() => pick(parsedQuery, [
QueryListParams.SortBy,
QueryListParams.Filters,
QueryListParams.Direction,
QueryListParams.Page,
QueryListParams.Query,
]),
[parsedQuery],
)
function storeParams(params: Partial<Params<ParamsT, FiltersT>>) {
setSearchParams(
stringify(
{ sortBy, direction, page, tab, filters, redirectUrl, ...params },
{ allowDots: true },
),
)
}
function clearParams(...params: string[]) {
const searchParamsKeys = Array.from(searchParams.keys())
const clearCandidates = params.length ? params : searchParamsKeys
for (const param of searchParamsKeys) {
for (const paramToClear of clearCandidates) {
if (param.startsWith(paramToClear) && searchParams.get(param)) {
searchParams.delete(param)
}
}
}
setSearchParams(searchParams)
}
function getParam(param: keyof Params<ParamsT, FiltersT> & string) {
searchParams.get(param)
}
return {
parsedQuery,
listParams,
filters: filters as unknown as FiltersT,
sortBy,
direction,
page,
tab,
redirectUrl,
storeParams,
clearParams,
getParam,
}
}
|