composed-navigation3/com.w2sv.composed.navigation3/Nav3Navigator

Nav3Navigator

abstract class Nav3Navigator<T : NavKey>(val backStack: NavBackStack<T>, log: (() -> String) -> Unit = {})

Provides guarded navigation operations for backStack, preventing redundant mutations and rejecting stale navigation requests.

Supports NestedNavHost destinations by prioritizing their nested back stacks during back navigation. Only one level of nesting is handled.

Back navigation preserves the root entry of each stack. The root stack must be non-empty, although direct mutations of backStack can violate this invariant.

Parameters

log

Optional callback for lazily logging skipped navigation operations. Messages are evaluated only when the callback invokes them.

Constructors

Nav3Navigator

constructor(backStack: NavBackStack<T>, log: (() -> String) -> Unit = {})

Properties

backStack

val backStack: NavBackStack<T>

currentRoute

val currentRoute: T

The current root route. An empty root stack is a structural navigator error.

Functions

popBackStack

open fun popBackStack()

Pops the active nested stack first, then falls back to the root stack.

fun popBackStack(from: NavKey): Boolean

Handles back navigation only when from equals the current route of the active stack.