29 lines
1.5 KiB
TypeScript
29 lines
1.5 KiB
TypeScript
import { AnyRouter, FromPathOption, NavigateOptions, RegisteredRouter, UseNavigateResult } from '@tanstack/router-core';
|
|
/**
|
|
* Imperative navigation hook.
|
|
*
|
|
* Returns a stable `navigate(options)` function to change the current location
|
|
* programmatically. Prefer the `Link` component for user-initiated navigation,
|
|
* and use this hook from effects, callbacks, or handlers where imperative
|
|
* navigation is required.
|
|
*
|
|
* Options:
|
|
* - `from`: Optional route base used to resolve relative `to` paths.
|
|
*
|
|
* @returns A function that accepts `NavigateOptions`.
|
|
* @link https://tanstack.com/router/latest/docs/framework/react/api/router/useNavigateHook
|
|
*/
|
|
export declare function useNavigate<TRouter extends AnyRouter = RegisteredRouter, TDefaultFrom extends string = string>(_defaultOpts?: {
|
|
from?: FromPathOption<TRouter, TDefaultFrom>;
|
|
}): UseNavigateResult<TDefaultFrom>;
|
|
/**
|
|
* Component that triggers a navigation when rendered. Navigation executes
|
|
* in an effect after mount/update.
|
|
*
|
|
* Props are the same as `NavigateOptions` used by `navigate()`.
|
|
*
|
|
* @returns null
|
|
* @link https://tanstack.com/router/latest/docs/framework/react/api/router/navigateComponent
|
|
*/
|
|
export declare function Navigate<TRouter extends AnyRouter = RegisteredRouter, const TFrom extends string = string, const TTo extends string | undefined = undefined, const TMaskFrom extends string = TFrom, const TMaskTo extends string = ''>(props: NavigateOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>): null;
|