Skip to content
Source
Sign inSign up
TanStack/router
Open History to see the last commit

useNavigate.tsx

43 lines1.1 KB

1import * as Solid from 'solid-js'
2import { useRouter } from './useRouter'
3import type {
4 AnyRouter,
5 FromPathOption,
6 NavigateOptions,
7 RegisteredRouter,
8 UseNavigateResult,
9} from '@tanstack/router-core'
10​
11export function useNavigate<
12 TRouter extends AnyRouter = RegisteredRouter,
13 TDefaultFrom extends string = string,
14>(_defaultOpts?: {
15 from?: FromPathOption<TRouter, TDefaultFrom>
16}): UseNavigateResult<TDefaultFrom> {
17 const router = useRouter()
18​
19 return ((options: NavigateOptions) => {
20 return router.navigate({
21 ...options,
22 from: options.from ?? _defaultOpts?.from,
23 })
24 }) as UseNavigateResult<TDefaultFrom>
26​
27export function Navigate<
28 TRouter extends AnyRouter = RegisteredRouter,
29 const TFrom extends string = string,
30 const TTo extends string | undefined = undefined,
31 const TMaskFrom extends string = TFrom,
32 const TMaskTo extends string = '',
33>(props: NavigateOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>): null {
34 const { navigate } = useRouter()
35​
36 Solid.onMount(() => {
37 navigate({
38 ...props,
39 })
40 })
41​
42 return null