# NavigationForwardHandler

Common/AllAndroid/JVM

## Functions summary

|---|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/navigationevent/compose/NavigationForwardHandler.composable#NavigationForwardHandler(androidx.navigationevent.compose.NavigationEventState,kotlin.Boolean,kotlin.Function0,kotlin.Function0)( state: https://developer.android.com/reference/kotlin/androidx/navigationevent/compose/NavigationEventState<https://developer.android.com/reference/kotlin/androidx/navigationevent/NavigationEventInfo>, isForwardEnabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, onForwardCancelled: () -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html, onForwardCompleted: () -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html )` A composable that handles only forward navigation gestures, driven by a manually hoisted `https://developer.android.com/reference/kotlin/androidx/navigationevent/compose/NavigationEventState`. | Cmn |

## Functions

### NavigationForwardHandler

Cmn Artifact: [androidx.navigationevent:navigationevent-compose](https://developer.android.com/jetpack/androidx/releases/navigationevent) [View Source](https://cs.android.com/search?q=file:androidx/navigationevent/compose/NavigationEventHandler.kt+function:NavigationForwardHandler) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/navigationevent#1.0.0)

```
@Composable
fun NavigationForwardHandler(
    state: NavigationEventState<NavigationEventInfo>,
    isForwardEnabled: Boolean = true,
    onForwardCancelled: () -> Unit = {},
    onForwardCompleted: () -> Unit
): Unit
```

A composable that handles only forward navigation gestures, driven by a manually hoisted `https://developer.android.com/reference/kotlin/androidx/navigationevent/compose/NavigationEventState`.

This is a convenience wrapper around the core `https://developer.android.com/reference/kotlin/androidx/navigationevent/NavigationEventHandler` overload for cases where back navigation is not relevant. Use this overload when hoisting state.

Refer to the primary `https://developer.android.com/reference/kotlin/androidx/navigationevent/NavigationEventHandler` KDoc for details on precedence, unconditional usage, and timing considerations.

| Parameters |
|---|---|
| `state: https://developer.android.com/reference/kotlin/androidx/navigationevent/compose/NavigationEventState<https://developer.android.com/reference/kotlin/androidx/navigationevent/NavigationEventInfo>` | The hoisted `https://developer.android.com/reference/kotlin/androidx/navigationevent/compose/NavigationEventState` (returned from `https://developer.android.com/reference/kotlin/androidx/navigationevent/compose/rememberNavigationEventState.composable#rememberNavigationEventState(androidx.navigationevent.NavigationEventInfo,kotlin.collections.List,kotlin.collections.List)`) to be registered. |
| `isForwardEnabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = true` | Controls whether forward navigation gestures are handled. |
| `onForwardCancelled: () -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html = {}` | Called if a forward navigation gesture is cancelled. |
| `onForwardCompleted: () -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | Called when a forward navigation gesture completes and navigation occurs. |