This class serves as the Compose-layer adapter for the navigation event system. It holds the developer-defined history partitions (currentInfo, backInfo, forwardInfo) and is updated with the local transitionState by the NavigationEventHandler it is provided to.

This object is created via rememberNavigationEventState and consumed by NavigationEventHandler to link the hoisted history state with the active handler's callbacks and gesture state.

See also
NavigationEventHandler

Summary

Public properties
List<T>

A list of destinations the user may navigate back to.
Cmn
T

The contextual information for the currently active destination.
Cmn
List<T>

A list of destinations the user may navigate forward to.
Cmn
NavigationEventTransitionState

The current physical gesture state from the dispatcher.
Cmn

Public properties

backInfo

Cmn
Added in 1.0.0-alpha09
val backInfo: List<T>

A list of destinations the user may navigate back to.

currentInfo

Cmn
Added in 1.0.0-alpha09
val currentInfo: T

The contextual information for the currently active destination.

forwardInfo

Cmn
Added in 1.0.0-alpha09
val forwardInfo: List<T>

A list of destinations the user may navigate forward to.

transitionState

Cmn
Added in 1.0.0-alpha09
val transitionState: NavigationEventTransitionState

The current physical gesture state from the dispatcher. This value is collected from the local NavigationEventHandler and will be either NavigationEventTransitionState.Idle or NavigationEventTransitionState.InProgress. This property will update frequently during a gesture.