androidx.navigation.testing | API reference

Kotlin |Java

Classes

`TestNavHostController`	Subclass of `NavHostController` that offers additional APIs for testing Navigation.	android
`TestNavigatorState`	An implementation of `NavigatorState` that allows testing a `androidx.navigation.Navigator` in isolation (i.e., without requiring a `androidx.navigation.NavController`).	android

Extension functions summary

operator SavedStateHandle

SavedStateHandle.Companion.invoke(
    route: Any,
    typeMap: Map<KType, NavType<*>>
)

SavedStateHandle constructor to create a SavedStateHandle with a serializable object.

Cmn

Extension functions

invoke

Cmn

Artifact: androidx.navigation:navigation-testing

View Source

Added in 2.8.0

operator fun SavedStateHandle.Companion.invoke(
    route: Any,
    typeMap: Map<KType, NavType<*>> = emptyMap()
): SavedStateHandle

SavedStateHandle constructor to create a SavedStateHandle with a serializable object.

Returns a SavedStateHandle populated with arguments from route.

Note: To use this api in non-instrumented tests, run with robolectric. This is because android's Bundle is necessarily integrated into the parsing of route arguments.

Parameters
`route: Any`	The route to extract argument values from
`typeMap: Map<KType, NavType<*>> = emptyMap()`	A mapping of KType to custom NavType<*> in the `route`. May be empty if `route` does not use custom NavTypes.