NavigationForwardHandler

Functions summary

Unit
@Composable
NavigationForwardHandler(
    state: NavigationEventState<NavigationEventInfo>,
    isForwardEnabled: Boolean,
    onForwardCancelled: () -> Unit,
    onForwardCompleted: () -> Unit
)

A composable that handles only forward navigation gestures, driven by a manually hoisted NavigationEventState.

Cmn

Functions

@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 NavigationEventState.

This is a convenience wrapper around the core NavigationEventHandler overload for cases where back navigation is not relevant. Use this overload when hoisting state.

Refer to the primary NavigationEventHandler KDoc for details on precedence, unconditional usage, and timing considerations.

Parameters
state: NavigationEventState<NavigationEventInfo>

The hoisted NavigationEventState (returned from rememberNavigationEventState) to be registered.

isForwardEnabled: Boolean = true

Controls whether forward navigation gestures are handled.

onForwardCancelled: () -> Unit = {}

Called if a forward navigation gesture is cancelled.

onForwardCompleted: () -> Unit

Called when a forward navigation gesture completes and navigation occurs.