React Routeways - API ReferenceDocs


React Routeways - API Reference / createNavigatorHook

Function: createNavigatorHook()

createNavigatorHook<T>(routes): () => NavigatorHook<T>

Creates a hook that returns a “Navigator” obeject from your custom routes. This provides natural experience of imperative navigation based on your routes structure.

Type Parameters

T extends Record<string, Routeway>

Parameters

routes: T

the custom Routeways routes

Returns

Function

a navigation hook of the custom Routeways routes

Returns

NavigatorHook<T>

Defined in

src/lib/hooks/createNavigatorHook.ts:39