GTKX

API Reference / @gtkx/navigation / useNavigationBuilder

Function: useNavigationBuilder() ​

useNavigationBuilder<State, RouterOptions, ActionHelpers, ScreenOptions, EventMap>(createRouter, options): object

Defined in: node_modules/.pnpm/@react-navigation+core@7.21.13_patch_hash=6462da01ed23beee88f01d290d3714743e43d2fd84235198fcbe09501a61d1d4_react@19.2.8/node_modules/@react-navigation/core/lib/typescript/src/useNavigationBuilder.d.ts:11

Hook for building navigators.

Type Parameters ​

State ​

State extends Readonly<{ history?: unknown[]; index: number; key: string; routeNames: string[]; routes: NavigationRoute<ParamListBase, string>[]; stale: false; type: string; }>

RouterOptions ​

RouterOptions extends DefaultRouterOptions

ActionHelpers ​

ActionHelpers extends Record<string, (...args) => void>

ScreenOptions ​

ScreenOptions extends object

EventMap ​

EventMap extends Record<string, any>

Parameters ​

createRouter ​

RouterFactory<State, Readonly<{ payload?: object; source?: string; target?: string; type: string; }>, RouterOptions>

Factory method which returns router object.

options ​

DefaultNavigatorOptions<ParamListBase, string | undefined, State, ScreenOptions, EventMap, any> & RouterOptions

Options object containing children and additional options for the router.

Returns ​

object

An object containing state, navigation, descriptors objects.

describe ​

describe: (route, placeholder) => Descriptor<ScreenOptions, Omit<object & PrivateValueStore<[ParamListBase, unknown, unknown]>, "getParent"> & object & object & EventConsumer<EventMap & EventMapCore<State>> & PrivateValueStore<[ParamListBase, string, EventMap]> & ActionHelpers, RouteProp<ParamListBase, string>>

Parameters ​

route ​

RouteProp<ParamListBase, string>

placeholder ​

boolean

Returns ​

Descriptor<ScreenOptions, Omit<object & PrivateValueStore<[ParamListBase, unknown, unknown]>, "getParent"> & object & object & EventConsumer<EventMap & EventMapCore<State>> & PrivateValueStore<[ParamListBase, string, EventMap]> & ActionHelpers, RouteProp<ParamListBase, string>>

descriptors ​

descriptors: Record<string, Descriptor>

navigation: object & PrivateValueStore<[ParamListBase, unknown, unknown]> & EventEmitter<EventMap> & object & ActionHelpers

Type Declaration ​

canGoBack() ​

canGoBack(): boolean

Returns ​

boolean

dispatch() ​

dispatch(action): void

Parameters ​
action ​

Readonly<{ payload?: object; source?: string; target?: string; type: string; }> | ((state) => Readonly<{ payload?: object; source?: string; target?: string; type: string; }>)

Returns ​

void

getId() ​

getId(): string | undefined

Returns ​

string | undefined

getParent() ​

getParent<T>(id?): T

Type Parameters ​
T ​

T = NavigationHelpers<ParamListBase, { }> | undefined

Parameters ​
id? ​

string

Returns ​

T

getState() ​

getState(): Readonly<{ history?: unknown[]; index: number; key: string; routeNames: string[]; routes: NavigationRoute[]; stale: false; type: string; }>

Returns ​

Readonly<{ history?: unknown[]; index: number; key: string; routeNames: string[]; routes: NavigationRoute[]; stale: false; type: string; }>

goBack() ​

goBack(): void

Returns ​

void

isFocused() ​

isFocused(): boolean

Returns ​

boolean

Call Signature ​

navigate<RouteName>(...args): void

Type Parameters ​
RouteName ​

RouteName extends string

Parameters ​
args ​

...RouteName extends unknown ? [RouteName, object, object] : never

Returns ​

void

Call Signature ​

navigate<RouteName>(options): void

Type Parameters ​
RouteName ​

RouteName extends string

Parameters ​
options ​

RouteName extends unknown ? object : never

Returns ​

void

Call Signature ​

navigateDeprecated<RouteName>(...args): void

Type Parameters ​
RouteName ​

RouteName extends string

Parameters ​
args ​

...RouteName extends unknown ? [RouteName, object] : never

Returns ​

void

Call Signature ​

navigateDeprecated<RouteName>(options): void

Type Parameters ​
RouteName ​

RouteName extends string

Parameters ​
options ​

RouteName extends unknown ? object : never

Returns ​

void

preload() ​

preload<RouteName>(...args): void

Type Parameters ​
RouteName ​

RouteName extends string

Parameters ​
args ​

...RouteName extends unknown ? [RouteName, object] : never

Returns ​

void

reset() ​

reset(state): void

Parameters ​
state ​

Readonly<{ history?: unknown[]; index: number; key: string; routeNames: string[]; routes: NavigationRoute<ParamListBase, string>[]; stale: false; type: string; }> | PartialState<Readonly<{ history?: unknown[]; index: number; key: string; routeNames: string[]; routes: NavigationRoute<ParamListBase, string>[]; stale: false; type: string; }>>

Returns ​

void

Type Declaration ​

replaceParams() ​

replaceParams(params): void

Parameters ​
params ​

object | undefined

Returns ​

void

setParams() ​

setParams(params): void

Parameters ​
params ​

Partial<object | undefined>

Returns ​

void

NavigationContent: (__namedParameters) => Element

Parameters ​

__namedParameters ​
children ​

ReactNode

Returns ​

Element

state ​

state: State