# androidx.navigationevent

*** ** * ** ***

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

## Annotations

|---|---|
| `https://developer.android.com/reference/androidx/navigationevent/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

|---|---|
| `https://developer.android.com/reference/androidx/navigationevent/NavigationEventDispatcherOwner` | A class that has an `https://developer.android.com/reference/androidx/navigationevent/NavigationEventDispatcher` that allows you to register a `https://developer.android.com/reference/androidx/navigationevent/NavigationEventHandler` for handling navigation events. |
| `https://developer.android.com/reference/androidx/navigationevent/OnBackCompletedFallback` | A listener that provides a final fallback action for unhandled `backCompleted` callbacks. |
| `https://developer.android.com/reference/androidx/navigationevent/OnForwardCompletedFallback` | A listener that provides a final fallback action for unhandled `forwardCompleted` callbacks. |

## Classes

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