NavHost

Kotlin |Java

interface NavHost

androidx.navigation.NavHost

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

Known Indirect Subclasses DynamicNavHostFragment 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(View, NavController) on their root view
• Route system Back button events to the NavController either by manually calling NavController#popBackStack() or by calling NavHostController#setOnBackPressedDispatcher(androidx.activity.OnBackPressedDispatcher) when constructing the NavController.

Optionally, a navigation host should consider calling:

• Call NavHostController#setLifecycleOwner(LifecycleOwner) to associate the NavController with a specific Lifecycle.
• Call NavHostController#setViewModelStore(ViewModelStore) to enable usage of NavController#getViewModelStoreOwner(int) and navigation graph scoped ViewModels.

Summary

Public methods
abstract NavController	getNavController() Returns the navigation controller for this navigation host.

Extension functions
From androidx.navigation NavGraph NavHost.createGraph(@IdRes id: Int = 0, @IdRes startDestination: Int, builder: NavGraphBuilder.() -> Unit) Construct a new NavGraph
From androidx.navigation.dynamicfeatures NavGraph NavHost.createGraph(@IdRes id: Int = 0, @IdRes startDestination: Int, builder: DynamicNavGraphBuilder.() -> Unit) Construct a new androidx.navigation.NavGraph that supports dynamic navigation destinations

Public methods

getNavController

@NonNull abstract fun getNavController(): NavController

Returns the navigation controller for this navigation host.

Return
NavController	this host's navigation controller