UNPKG

@react-navigation/core/lib/typescript/src/useRoute.d.ts

Version:

301 BTypeScriptView Raw

1import type { ParamListBase } from '@react-navigation/routers';
2import type { RouteProp } from './types';
3/**
4 * Hook to access the route prop of the parent screen anywhere.
5 *
6 * @returns Route prop of the parent screen.
7 */
8export default function useRoute<T extends RouteProp<ParamListBase>>(): T;

1	`import type { ParamListBase } from '@react-navigation/routers';`
2	`import type { RouteProp } from './types';`
3	`/**`
4	`* Hook to access the route prop of the parent screen anywhere.`
5	`*`
6	`* @returns Route prop of the parent screen.`
7	`*/`
8	`export default function useRoute<T extends RouteProp<ParamListBase>>(): T;`