androidx.navigationevent

Kotlin |Java

Provides APIs to easily intercept platform gesture events, including swipes and clicks, to help in app navigation.

Annotations

ExperimentalNavigationEventApi

Marks declarations that are still experimental in the NavigationEvent API, which means that the design of the corresponding declarations has open issues which may (or may not) lead to changes in the future.

Interfaces

`NavigationEventDispatcherOwner`	A class that has an `NavigationEventDispatcher` that allows you to register a `NavigationEventHandler` for handling navigation events.
`OnBackCompletedFallback`	A listener that provides a final fallback action for unhandled `backCompleted` callbacks.
`OnForwardCompletedFallback`	A listener that provides a final fallback action for unhandled `forwardCompleted` callbacks.

Classes

`BrowserInput`	A `NavigationEventInput` that translates browser history navigation events (popstate) into `NavigationEventDispatcher` events.
`DirectNavigationEventInput`	An input that can send events to a `NavigationEventDispatcher`.
`NavigationEvent`	Represents a system navigation event, such as a predictive back gesture or a back button press.
`NavigationEventDispatcher`	A dispatcher for navigation events that can be organized hierarchically.
`NavigationEventDispatcherOwnerFactory`
`NavigationEventHandler`	Base class for handling navigation gestures dispatched by a `NavigationEventDispatcher`.
`NavigationEventHistory`	Represents an immutable snapshot of the navigation history stack.
`NavigationEventInfo`	Provides contextual information about a navigation state (e.g., a screen or route).
`NavigationEventInput`	An abstract class for components that generate and dispatch navigation events.
`NavigationEventKt`
`NavigationEventTransitionState`	Represents the physical state of a navigation gesture, such as a predictive back or forward swipe.
`NavigationEventTransitionState.InProgress`	Represents the state where a navigation gesture is actively in progress.
`OnBackInvokedDefaultInput`	Provides input to a `NavigationEventDispatcher` by registering an `OnBackInvokedCallback` with the `OnBackInvokedDispatcher.PRIORITY_DEFAULT` priority to `onBackInvokedDispatcher`.
`OnBackInvokedInput`	Provides input to a `NavigationEventDispatcher` by registering an `OnBackInvokedCallback` to the passed in `onBackInvokedDispatcher`.
`OnBackInvokedOverlayInput`	Provides input to a `NavigationEventDispatcher` by registering an `OnBackInvokedCallback` with the `OnBackInvokedDispatcher.PRIORITY_OVERLAY` priority to `onBackInvokedDispatcher`.
`ViewTreeNavigationEventDispatcherOwner`
`NavigationEventInfo.None`	A default used when no specific information is associated with a navigation event.
`NavigationEventTransitionState.Idle`	Represents the state where no navigation gesture is currently in progress.