NavHost

Artifact: androidx.navigation:navigation-runtime

View Source

Added in 1.0.0

Kotlin |Java

Cmn
```
interface NavHost
```

Known direct subclasses

NavHostFragment

NavHostFragment

NavHostFragment provides an area within your layout for self-contained navigation to occur.

Known indirect subclasses

ComposableNavHostFragment, DynamicNavHostFragment

`ComposableNavHostFragment`	A `NavHostFragment` that adds support for `ComposableFragment` instances via `ComposableFragmentNavigator`.
`DynamicNavHostFragment`	The `NavHostFragment` for dynamic features.

A host is a single context or container for navigation via a NavController.

It is strongly recommended to construct the nav controller by instantiating a NavHostController, which offers additional APIs specifically for a NavHost. The NavHostController should still only be externally accessible as a NavController, rather than directly exposing it as a NavHostController.

Navigation hosts must:

Handle saving and restoring their controller's state
Call Navigation.setViewNavController on their root view
Route system Back button events to the NavController either by manually calling NavController.popBackStack or by calling NavHostController.setOnBackPressedDispatcher when constructing the NavController.

Optionally, a navigation host should consider calling:

Call NavHostController.setLifecycleOwner to associate the NavController with a specific Lifecycle.
Call NavHostController.setViewModelStore to enable usage of NavController.getViewModelStoreOwner and navigation graph scoped ViewModels.

Summary

Public properties
`NavController`	`navController` The `navigation controller` for this navigation host.	Cmn

Extension functions
`inline NavGraph`	`NavHost.createGraph( id: @IdRes Int, startDestination: @IdRes Int, builder: NavGraphBuilder.() -> Unit )` This function is deprecated. Use routes to create your NavGraph instead	android
`inline NavGraph`	`NavHost.createGraph( id: @IdRes Int, startDestination: @IdRes Int, builder: DynamicNavGraphBuilder.() -> Unit )` This function is deprecated. Use routes to create your dynamic NavGraph instead	android
`inline NavGraph`	`NavHost.createGraph( startDestination: String, route: String?, builder: NavGraphBuilder.() -> Unit )` Construct a new `NavGraph`	Cmn
`inline NavGraph`	`NavHost.createGraph( startDestination: String, route: String?, builder: DynamicNavGraphBuilder.() -> Unit )` Construct a new `androidx.navigation.NavGraph` that supports dynamic navigation destinations	android
`inline NavGraph`	`NavHost.createGraph( startDestination: Any, route: KClass<>?, typeMap: Map<KType, NavType<>>, builder: NavGraphBuilder.() -> Unit )` Construct a new `NavGraph`	Cmn
`inline NavGraph`	`NavHost.createGraph( startDestination: Any, route: KClass<>?, typeMap: Map<KType, NavType<>>, builder: DynamicNavGraphBuilder.() -> Unit )` Construct a new `androidx.navigation.NavGraph` that supports dynamic navigation destinations	android
`inline NavGraph`	`NavHost.createGraph( startDestination: KClass<>, route: KClass<>?, typeMap: Map<KType, NavType<*>>, builder: NavGraphBuilder.() -> Unit )` Construct a new `NavGraph`	Cmn
`inline NavGraph`	`NavHost.createGraph( startDestination: KClass<>, route: KClass<>?, typeMap: Map<KType, NavType<*>>, builder: DynamicNavGraphBuilder.() -> Unit )` Construct a new `androidx.navigation.NavGraph` that supports dynamic navigation destinations	android

Public properties

navController

Cmn

Added in 1.0.0

val navController: NavController

The navigation controller for this navigation host.

Extension functions

android

Artifact: androidx.navigation:navigation-runtime

View Source

inline fun NavHost.createGraph(
    id: @IdRes Int = 0,
    startDestination: @IdRes Int,
    builder: NavGraphBuilder.() -> Unit
): NavGraph

Construct a new NavGraph

android

Artifact: androidx.navigation:navigation-dynamic-features-runtime

View Source

inline fun NavHost.createGraph(
    id: @IdRes Int = 0,
    startDestination: @IdRes Int,
    builder: DynamicNavGraphBuilder.() -> Unit
): NavGraph

Construct a new androidx.navigation.NavGraph that supports dynamic navigation destinations

Cmn

Artifact: androidx.navigation:navigation-runtime

View Source

inline fun NavHost.createGraph(
    startDestination: String,
    route: String? = null,
    builder: NavGraphBuilder.() -> Unit
): NavGraph

Construct a new NavGraph

android

Artifact: androidx.navigation:navigation-dynamic-features-runtime

View Source

inline fun NavHost.createGraph(
    startDestination: String,
    route: String? = null,
    builder: DynamicNavGraphBuilder.() -> Unit
): NavGraph

Construct a new androidx.navigation.NavGraph that supports dynamic navigation destinations

Cmn

Artifact: androidx.navigation:navigation-runtime

View Source

inline fun NavHost.createGraph(
    startDestination: Any,
    route: KClass<*>? = null,
    typeMap: Map<KType, NavType<*>> = emptyMap(),
    builder: NavGraphBuilder.() -> Unit
): NavGraph

Construct a new NavGraph

Parameters
`startDestination: Any`	the starting destination's route from an Object for this NavGraph. The respective NavDestination must be added as a `KClass` in order to match.
`route: KClass<*>? = null`	the graph's unique route from a `KClass`
`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.
`builder: NavGraphBuilder.() -> Unit`	the builder used to construct the graph

android

Artifact: androidx.navigation:navigation-dynamic-features-runtime

View Source

inline fun NavHost.createGraph(
    startDestination: Any,
    route: KClass<*>? = null,
    typeMap: Map<KType, NavType<*>> = emptyMap(),
    builder: DynamicNavGraphBuilder.() -> Unit
): NavGraph

Construct a new androidx.navigation.NavGraph that supports dynamic navigation destinations

Parameters
`startDestination: Any`	the starting destination's route from an Object for this NavGraph. The respective NavDestination must be added as a `KClass` in order to match.
`route: KClass<*>? = null`	the graph's unique route from a `KClass`
`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.
`builder: DynamicNavGraphBuilder.() -> Unit`	the builder used to construct the graph

Cmn

Artifact: androidx.navigation:navigation-runtime

View Source

inline fun NavHost.createGraph(
    startDestination: KClass<*>,
    route: KClass<*>? = null,
    typeMap: Map<KType, NavType<*>> = emptyMap(),
    builder: NavGraphBuilder.() -> Unit
): NavGraph

Construct a new NavGraph

Parameters
`startDestination: KClass<*>`	the starting destination's route from a `KClass` for this NavGraph. The respective NavDestination must be added as a `KClass` in order to match.
`route: KClass<*>? = null`	the graph's unique route from a `KClass`
`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.
`builder: NavGraphBuilder.() -> Unit`	the builder used to construct the graph

android

Artifact: androidx.navigation:navigation-dynamic-features-runtime

View Source

inline fun NavHost.createGraph(
    startDestination: KClass<*>,
    route: KClass<*>? = null,
    typeMap: Map<KType, NavType<*>> = emptyMap(),
    builder: DynamicNavGraphBuilder.() -> Unit
): NavGraph

Construct a new androidx.navigation.NavGraph that supports dynamic navigation destinations

Parameters
`startDestination: KClass<*>`	the starting destination's route from a `KClass` for this NavGraph. The respective NavDestination must be added as a `KClass` in order to match.
`route: KClass<*>? = null`	the graph's unique route from a `KClass`
`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.
`builder: DynamicNavGraphBuilder.() -> Unit`	the builder used to construct the graph