TestNavigatorState

Artifact: androidx.navigation:navigation-testing

View Source

Added in 2.4.0

---

Kotlin |Java

class TestNavigatorState : NavigatorState

kotlin.Any
↳	androidx.navigation.NavigatorState
	↳	androidx.navigation.testing.TestNavigatorState

---

An implementation of NavigatorState that allows testing a androidx.navigation.Navigator in isolation (i.e., without requiring a androidx.navigation.NavController).

An optional context can be provided to allow for the usages of androidx.lifecycle.AndroidViewModel within the created NavBackStackEntry instances.

The Lifecycle of all NavBackStackEntry instances added to this TestNavigatorState will be updated as they are added and removed from the state. This work is kicked off on the coroutineDispatcher.

Summary

Public constructors
TestNavigatorState(     context: Context?,     coroutineDispatcher: CoroutineDispatcher )

Public functions
open NavBackStackEntry	createBackStackEntry(destination: NavDestination, arguments: Bundle?)
open Unit	markTransitionComplete(entry: NavBackStackEntry)
open Unit	pop(popUpTo: NavBackStackEntry, saveState: Boolean)
open Unit	popWithTransition(popUpTo: NavBackStackEntry, saveState: Boolean)
open Unit	prepareForTransition(entry: NavBackStackEntry)
open Unit	push(backStackEntry: NavBackStackEntry)
NavBackStackEntry	restoreBackStackEntry(previouslySavedEntry: NavBackStackEntry) Restore a previously saved NavBackStackEntry.

Inherited functions
From androidx.navigation.NavigatorState abstract NavBackStackEntry createBackStackEntry(destination: NavDestination, arguments: SavedState?) open Unit @CallSuper onLaunchSingleTop(backStackEntry: NavBackStackEntry) open Unit @CallSuper onLaunchSingleTopWithTransition(backStackEntry: NavBackStackEntry) open Unit pushWithTransition(backStackEntry: NavBackStackEntry)

Inherited properties
From androidx.navigation.NavigatorState StateFlow<List<NavBackStackEntry>> backStack StateFlow<Set<NavBackStackEntry>> transitionsInProgress

Public constructors

TestNavigatorState

Added in 2.4.0

TestNavigatorState(
    context: Context? = null,
    coroutineDispatcher: CoroutineDispatcher = Dispatchers.Main.immediate
)

Public functions

createBackStackEntry

Added in 2.4.0

open fun createBackStackEntry(destination: NavDestination, arguments: Bundle?): NavBackStackEntry

markTransitionComplete

open fun markTransitionComplete(entry: NavBackStackEntry): Unit

pop

open fun pop(popUpTo: NavBackStackEntry, saveState: Boolean): Unit

popWithTransition

open fun popWithTransition(popUpTo: NavBackStackEntry, saveState: Boolean): Unit

prepareForTransition

open fun prepareForTransition(entry: NavBackStackEntry): Unit

push

open fun push(backStackEntry: NavBackStackEntry): Unit

restoreBackStackEntry

Added in 2.4.0

fun restoreBackStackEntry(previouslySavedEntry: NavBackStackEntry): NavBackStackEntry

Restore a previously saved NavBackStackEntry. You must have previously called pop with previouslySavedEntry and true.