API Reference / @gtkx/navigation / NavigationContainerEventMap

Type Alias: NavigationContainerEventMap

NavigationContainerEventMap = 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/types.d.ts:628

Properties

__unsafe_action__

__unsafe_action__: object

Event that fires when an action is dispatched. Only intended for debugging purposes, don't use it for app logic. This event will be emitted before state changes have been applied.

data

data: object

data.action

action: NavigationAction

The action object that was dispatched.

data.noop

noop: boolean

Whether the action was a no-op, i.e. resulted any state changes.

data.stack

stack: string | undefined

Stack trace of the action, this will only be available during development.

__unsafe_event__

__unsafe_event__: object

Event that fires when an event is emitted. Only intended for debugging purposes, don't use it for app logic. This event will be emitted after all listeners have been called.

data

data: object

data.data?

optional data?: unknown

The data object passed when emitting the event.

data.defaultPrevented?

optional defaultPrevented?: boolean

Whether event.preventDefault() was called on this event.

data.preventDefault?

optional preventDefault?: () => void

Prevent the default action which happens on this event.

Returns

void

data.target?

optional target?: string

The key of the target route which received the event.

data.type

type: string

The type of the event that was emitted.

options

options: object

Event that fires when current options changes.

data

data: object

data.options

options: object

ready

ready: object

Event that fires when the navigation container is ready to be used.

data

data: undefined

state

state: object

Event that fires when the navigation state changes.

data

data: object

data.state

state: NavigationState | PartialState<NavigationState> | undefined

The updated state object after the state change.

Type Alias: NavigationContainerEventMap ​

Properties ​

__unsafe_action__ ​

data ​

data.action ​

data.noop ​

data.stack ​

__unsafe_event__ ​

data ​

data.data? ​

data.defaultPrevented? ​

data.preventDefault? ​

Returns ​

data.target? ​

data.type ​

options ​

data ​

data.options ​

ready ​

data ​

state ​

data ​

data.state ​

Type Alias: NavigationContainerEventMap

Properties

__unsafe_action__

data

data.action

data.noop

data.stack

__unsafe_event__

data

data.data?

data.defaultPrevented?

data.preventDefault?

Returns

data.target?

data.type

options

data

data.options

ready

data

state

data

data.state