API Reference / @gtkx/navigation / BaseRouter

Variable: BaseRouter

const BaseRouter: object

Defined in: node_modules/.pnpm/@react-navigation+routers@7.6.4/node_modules/@react-navigation/routers/lib/typescript/src/BaseRouter.d.ts:7

Base router object that can be used when writing custom routers. This provides few helper methods to handle common actions such as RESET.

Type Declaration

getStateForAction

getStateForAction: typeof getStateForAction

shouldActionChangeFocus()

shouldActionChangeFocus(action): action is { payload: { merge?: boolean; name: string; params?: object; path?: string; pop?: boolean }; source?: string; target?: string; type: "NAVIGATE" } | { payload: { merge?: boolean; name: string; params?: object }; source?: string; target?: string; type: "NAVIGATE_DEPRECATED" }

Parameters

action

Action

Returns

action is { payload: { merge?: boolean; name: string; params?: object; path?: string; pop?: boolean }; source?: string; target?: string; type: "NAVIGATE" } | { payload: { merge?: boolean; name: string; params?: object }; source?: string; target?: string; type: "NAVIGATE_DEPRECATED" }