TestNavHostController

kotlin.Any
   ↳ androidx.navigation.NavController
     ↳ androidx.navigation.NavHostController
       ↳ androidx.navigation.testing.TestNavHostController

Subclass of NavHostController that offers additional APIs for testing Navigation.

Summary

Public constructors
android

Public functions
Unit

Navigate directly to any destination on the current androidx.navigation.NavGraph via an explicit deep link.
android
Unit
setCurrentDestination(destRoute: String, args: Bundle)

Navigate directly to any destination on the current androidx.navigation.NavGraph via an explicit deep link.
android

Public properties
List<NavBackStackEntry>

Gets an immutable copy of the elements currently on the back stack.
android

Inherited functions
From androidx.navigation.NavController
open Unit

Adds an OnDestinationChangedListener to this controller to receive a callback whenever the currentDestination or its arguments change.
android
inline Boolean

Clears any saved state associated with KClass T that was previously saved via popBackStack when using a saveState value of true.
android
Boolean

Clears any saved state associated with destinationId that was previously saved via popBackStack when using a saveState value of true.
android
Boolean
@MainThread
<T : Any> clearBackStack(route: KClass<T>)

Clears any saved state associated with KClass route that was previously saved via popBackStack when using a saveState value of true.
android
Boolean
@MainThread
<T : Any> clearBackStack(route: T)

Clears any saved state associated with KClass T that was previously saved via popBackStack when using a saveState value of true.
android
Boolean

Clears any saved state associated with route that was previously saved via popBackStack when using a saveState value of true.
android
open NavDeepLinkBuilder

Create a deep link to a destination within this NavController.
android
inline NavBackStackEntry

Gets the topmost NavBackStackEntry for a route from KClass.
android
open NavBackStackEntry
getBackStackEntry(destinationId: @IdRes Int)

Gets the topmost NavBackStackEntry for a destination id.
android
NavBackStackEntry
<T : Any> getBackStackEntry(route: KClass<T>)

Gets the topmost NavBackStackEntry for a route from KClass.
android
NavBackStackEntry
<T : Any> getBackStackEntry(route: T)

Gets the topmost NavBackStackEntry for a route from an Object.
android
NavBackStackEntry

Gets the topmost NavBackStackEntry for a route.
android
open ViewModelStoreOwner

Gets the ViewModelStoreOwner for a NavGraph.
android
open Boolean

Checks the given Intent for a Navigation deep link and navigates to the deep link if present.
android
Boolean

Checks the given NavDeepLinkRequest for a Navigation deep link and navigates to the destination if present.
android
open Unit
@MainThread
navigate(deepLink: Uri)

Navigate to a destination via the given deep link Uri.
android
open Unit

Navigate via the given NavDirections
android
open Unit

Navigate to a destination via the given NavDeepLinkRequest.
android
open Unit

Navigate to a destination from the current navigation graph.
android
open Unit
@MainThread
navigate(deepLink: Uri, navOptions: NavOptions?)

Navigate to a destination via the given deep link Uri.
android
open Unit
@MainThread
navigate(directions: NavDirections, navOptions: NavOptions?)

Navigate via the given NavDirections
android
open Unit
@MainThread
navigate(directions: NavDirections, navigatorExtras: Navigator.Extras)

Navigate via the given NavDirections
android
open Unit

Navigate to a destination via the given NavDeepLinkRequest.
android
open Unit
@MainThread
navigate(resId: @IdRes Int, args: Bundle?)

Navigate to a destination from the current navigation graph.
android
Unit
@MainThread
<T : Any> navigate(route: T, builder: NavOptionsBuilder.() -> Unit)

Navigate to a route from an Object in the current NavGraph.
android
Unit
@MainThread
navigate(route: String, builder: NavOptionsBuilder.() -> Unit)

Navigate to a route in the current NavGraph.
android
open Unit
@MainThread
navigate(
    deepLink: Uri,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
)

Navigate to a destination via the given deep link Uri.
android
open Unit
@MainThread
navigate(
    request: NavDeepLinkRequest,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
)

Navigate to a destination via the given NavDeepLinkRequest.
android
open Unit
@MainThread
navigate(resId: @IdRes Int, args: Bundle?, navOptions: NavOptions?)

Navigate to a destination from the current navigation graph.
android
Unit
@MainThread
<T : Any> navigate(
    route: T,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
)

Navigate to a route from an Object in the current NavGraph.
android
Unit
@MainThread
navigate(
    route: String,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
)

Navigate to a route in the current NavGraph.
android
open Unit
@MainThread
navigate(
    resId: @IdRes Int,
    args: Bundle?,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
)

Navigate to a destination from the current navigation graph.
android
open Boolean

Attempts to navigate up in the navigation hierarchy.
android
open Boolean

Attempts to pop the controller's back stack.
android
open Boolean
@MainThread
popBackStack(destinationId: @IdRes Int, inclusive: Boolean)

Attempts to pop the controller's back stack back to a specific destination.
android
inline Boolean
@MainThread
<T : Any> popBackStack(inclusive: Boolean, saveState: Boolean)

Attempts to pop the controller's back stack back to a specific destination.
android
open Boolean
@MainThread
popBackStack(
    destinationId: @IdRes Int,
    inclusive: Boolean,
    saveState: Boolean
)

Attempts to pop the controller's back stack back to a specific destination.
android
Boolean
@MainThread
<T : Any> popBackStack(
    route: KClass<T>,
    inclusive: Boolean,
    saveState: Boolean
)

Attempts to pop the controller's back stack back to a specific destination.
android
Boolean
@MainThread
<T : Any> popBackStack(route: T, inclusive: Boolean, saveState: Boolean)

Attempts to pop the controller's back stack back to a specific destination.
android
Boolean
@MainThread
popBackStack(route: String, inclusive: Boolean, saveState: Boolean)

Attempts to pop the controller's back stack back to a specific destination.
android
open Unit

Removes an OnDestinationChangedListener from this controller.
android
open Unit

Restores all navigation controller state from a SavedState.
android
open Bundle?

Saves all navigation controller state to a SavedState.
android
open Unit

Sets the navigation graph to the specified resource.
android
open Unit
@MainThread
@CallSuper
setGraph(graph: NavGraph, startDestinationArgs: Bundle?)

Sets the navigation graph to the specified graph.
android
open Unit
@MainThread
@CallSuper
setGraph(graphResId: @NavigationRes Int, startDestinationArgs: Bundle?)

Sets the navigation graph to the specified resource.
android
From androidx.navigation.NavHostController
final Unit

Set whether the NavController should handle the system Back button events via the registered OnBackPressedDispatcher.
android
final Unit

Sets the host's LifecycleOwner.
android
final Unit

Sets the host's OnBackPressedDispatcher.
android
final Unit

Sets the host's ViewModelStore used by the NavController to store ViewModels at the navigation graph level.
android

Inherited properties
From androidx.navigation.NavController
open NavBackStackEntry?

The topmost NavBackStackEntry.
android
Flow<NavBackStackEntry>

A Flow that will emit the currently active NavBackStackEntry whenever it changes.
android
open NavDestination?

The current destination.
android
open NavGraph

The topmost navigation graph associated with this NavController.
android
open NavInflater

The inflater for this controller.
android
open NavigatorProvider

The NavController's NavigatorProvider.
android
open NavBackStackEntry?

The previous visible NavBackStackEntry.
android
StateFlow<List<NavBackStackEntry>>

A StateFlow that will emit the currently visible NavBackStackEntries whenever they change.
android

Public constructors

TestNavHostController

android
Added in 2.3.0
TestNavHostController(context: Context)

Public functions

setCurrentDestination

android
Added in 2.3.0
fun setCurrentDestination(destId: @IdRes Int, args: Bundle = savedState()): Unit

Navigate directly to any destination on the current androidx.navigation.NavGraph via an explicit deep link. If an implicit deep link exists for this destination use #navigate(Uri) instead.

Parameters
destId: @IdRes Int

The destination id to navigate to.
args: Bundle = savedState()

The arguments to pass to the destination.
Throws
IllegalArgumentException

If the destination does not exist on the NavGraph.

setCurrentDestination

android
Added in 2.4.0
fun setCurrentDestination(destRoute: String, args: Bundle = savedState()): Unit

Navigate directly to any destination on the current androidx.navigation.NavGraph via an explicit deep link. If an implicit deep link exists for this destination use #navigate(Uri) instead.

Parameters
destRoute: String

The destination route to navigate to.
args: Bundle = savedState()

The arguments to pass to the destination.
Throws
IllegalArgumentException

If the destination does not exist on the NavGraph.

Public properties

backStack

android
Added in 2.3.0
val backStack: List<NavBackStackEntry>

Gets an immutable copy of the elements currently on the back stack.