raviger
Version:
React routing with hooks
15 lines (14 loc) • 658 B
TypeScript
import type { QueryParam } from './querystring';
export interface NavigateOptions {
/**
* Use a `replace` instead of `push` for navigation
* @default false */
replace?: boolean;
/** Values to serialize as a querystring, which will be appended to the `url` */
query?: QueryParam | URLSearchParams;
/** value to pass as the state/data to history push/replace*/
state?: unknown;
}
export declare function navigate(url: string, options?: NavigateOptions): void;
export declare function useNavigationPrompt(predicate?: boolean, prompt?: string): void;
export declare function useNavigate(optBasePath?: string): typeof navigate;