Skip to content
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

Support custom regex to match route path parts #132

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Support custom regex to match route path parts #132

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
023816f
Support custom regex to match route path parts
rkok Aug 18, 2023
c819723
Fix matcher regex
rkok Aug 18, 2023
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
32 changes: 22 additions & 10 deletions src/router.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,14 @@ export interface PathParamOptions {
basePath?: string
matchTrailingSlash?: boolean
}
export interface RouteMatcherOptions {
partRegex?: string
}
export interface RouteOptionParams extends PathParamOptions {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
routeProps?: { [k: string]: any }
overridePathParams?: boolean
matcherOpts?: RouteMatcherOptions
}
interface RouteMatcher {
path: string
Expand Down Expand Up @@ -44,6 +48,7 @@ export function useRoutes<Path extends string>(
routeProps = {},
overridePathParams = true,
matchTrailingSlash = true,
matcherOpts = {}
}: RouteOptionParams = {}
): JSX.Element | null {
/*
Expand All @@ -64,6 +69,7 @@ export function useRoutes<Path extends string>(
routeProps,
overridePathParams,
matchTrailingSlash,
matcherOpts
})

// No match should not return an empty Provider, just null
Expand All @@ -83,10 +89,11 @@ function useMatchRoute(
routeProps,
overridePathParams,
matchTrailingSlash,
}: Omit<RouteOptionParams, 'basePath' | 'matchTrailingSlash'> & { matchTrailingSlash: boolean }
matcherOpts
}: Omit<RouteOptionParams, 'basePath' | 'matchTrailingSlash'> & { matchTrailingSlash: boolean, matcherOpts: RouteMatcherOptions }
) {
path = trailingMatch(path, matchTrailingSlash)
const matchers = useMatchers(Object.keys(routes))
const matchers = useMatchers(Object.keys(routes), matcherOpts)

if (path === null) return null
const [routeMatch, props] = getMatchParams(path, matchers)
Expand Down Expand Up @@ -158,17 +165,19 @@ export function useMatch(routes: string | string[], options: PathParamOptions =

function usePathOptions(
routeOrRoutes: string | string[],
{ basePath, matchTrailingSlash = true }: PathParamOptions
{ basePath, matchTrailingSlash = true, matcherOpts }: PathParamOptions & { matcherOpts?: RouteMatcherOptions}
): [string | null, RouteMatcher[]] {
const routes = (!Array.isArray(routeOrRoutes) ? [routeOrRoutes] : routeOrRoutes) as string[]
const matchers = useMatchers(routes)
const matchers = useMatchers(routes, matcherOpts)

return [trailingMatch(usePath(basePath), matchTrailingSlash), matchers]
}

function useMatchers(routes: string[]): RouteMatcher[] {
// eslint-disable-next-line react-hooks/exhaustive-deps
return useMemo(() => routes.map(createRouteMatcher), [hashParams(routes)])
function useMatchers(routes: string[], opts?: RouteMatcherOptions): RouteMatcher[] {
return useMemo(() => {
return routes.map(route => createRouteMatcher(route, opts))
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [hashParams(routes)])
}

function getMatchParams(
Expand All @@ -195,16 +204,19 @@ function getMatchParams(
return [routeMatch, props]
}

function createRouteMatcher(path: string): RouteMatcher {
function createRouteMatcher(path: string, {
partRegex = ':[a-zA-Z]+'
}: RouteMatcherOptions = {}): RouteMatcher {
const partMatcher = new RegExp(partRegex, 'g')
return {
path,
regex: new RegExp(
`${path.substr(0, 1) === '*' ? '' : '^'}${escapeRegExp(path)
.replace(/:[a-zA-Z]+/g, '([^/]+)')
.replace(partMatcher, '([^/]+)')
.replace(/\*/g, '')}${path.substr(-1) === '*' ? '' : '$'}`,
'i'
),
props: (path.match(/:[a-zA-Z]+/g) ?? []).map((paramName) => paramName.substr(1)),
props: (partMatcher.exec(path) ?? []).map((paramName) => paramName.substr(1))
}
}

Expand Down