NavHostController

Artifact: androidx.navigation:navigation-runtime

View Source

Added in 2.1.0

---

Kotlin |Java

Common/AllAndroid/JVM

• Cmn

  class NavHostController : NavController

• android

  open class NavHostController : NavController

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

Known direct subclasses

TestNavHostController

TestNavHostController

Subclass of NavHostController that offers additional APIs for testing Navigation.

---

Subclass of NavController that offers additional APIs for use by a NavHost to connect the NavController to external dependencies.

Apps should generally not construct controllers, instead obtain a relevant controller directly from a navigation host via NavHost.navController or by using one of the utility methods on the Navigation class.

Summary

Public constructors
NavHostController()	android
NavHostController(context: Context)	android

Public functions
final Unit	enableOnBackPressed(enabled: Boolean) Set whether the NavController should handle the system Back button events via the registered OnBackPressedDispatcher.	android
final Unit	setLifecycleOwner(owner: LifecycleOwner) Sets the host's LifecycleOwner.	Cmn android
final Unit	setOnBackPressedDispatcher(dispatcher: OnBackPressedDispatcher) Sets the host's OnBackPressedDispatcher.	android
final Unit	setViewModelStore(viewModelStore: ViewModelStore) Sets the host's ViewModelStore used by the NavController to store ViewModels at the navigation graph level.	Cmn android

Inherited functions

From androidx.navigation.NavController open Unit addOnDestinationChangedListener(     listener: NavController.OnDestinationChangedListener ) Adds an OnDestinationChangedListener to this controller to receive a callback whenever the currentDestination or its arguments change. Cmn android inline Boolean @MainThread <T : Any> clearBackStack() Clears any saved state associated with KClass T that was previously saved via popBackStack when using a saveState value of true. Cmn android Boolean @MainThread clearBackStack(destinationId: @IdRes Int) 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. Cmn 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. Cmn android Boolean @MainThread clearBackStack(route: String) Clears any saved state associated with route that was previously saved via popBackStack when using a saveState value of true. Cmn android open NavDeepLinkBuilder createDeepLink() Create a deep link to a destination within this NavController. android inline NavBackStackEntry <T : Any> getBackStackEntry() Gets the topmost NavBackStackEntry for a route from KClass. Cmn 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. Cmn android NavBackStackEntry <T : Any> getBackStackEntry(route: T) Gets the topmost NavBackStackEntry for a route from an Object. Cmn android NavBackStackEntry getBackStackEntry(route: String) Gets the topmost NavBackStackEntry for a route. Cmn android open ViewModelStoreOwner getViewModelStoreOwner(navGraphId: @IdRes Int) Gets the ViewModelStoreOwner for a NavGraph. android open Boolean @MainThread handleDeepLink(intent: Intent?) Checks the given Intent for a Navigation deep link and navigates to the deep link if present. android Boolean @MainThread handleDeepLink(request: NavDeepLinkRequest) Checks the given NavDeepLinkRequest for a Navigation deep link and navigates to the destination if present. Cmn android open Unit @MainThread navigate(deepLink: NavUri) Navigate to a destination via the given deep link Uri. Cmn android open Unit @MainThread navigate(directions: NavDirections) Navigate via the given NavDirections android open Unit @MainThread navigate(request: NavDeepLinkRequest) Navigate to a destination via the given NavDeepLinkRequest. Cmn android open Unit @MainThread navigate(resId: @IdRes Int) Navigate to a destination from the current navigation graph. android open Unit @MainThread navigate(deepLink: NavUri, navOptions: NavOptions?) Navigate to a destination via the given deep link Uri. Cmn 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 @MainThread navigate(request: NavDeepLinkRequest, navOptions: NavOptions?) Navigate to a destination via the given NavDeepLinkRequest. Cmn 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. Cmn android Unit @MainThread navigate(route: String, builder: NavOptionsBuilder.() -> Unit) Navigate to a route in the current NavGraph. Cmn android open Unit @MainThread navigate(     deepLink: NavUri,     navOptions: NavOptions?,     navigatorExtras: Navigator.Extras? ) Navigate to a destination via the given deep link Uri. Cmn android open Unit @MainThread navigate(     request: NavDeepLinkRequest,     navOptions: NavOptions?,     navigatorExtras: Navigator.Extras? ) Navigate to a destination via the given NavDeepLinkRequest. Cmn 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. Cmn android Unit @MainThread navigate(     route: String,     navOptions: NavOptions?,     navigatorExtras: Navigator.Extras? ) Navigate to a route in the current NavGraph. Cmn 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 @MainThread navigateUp() Attempts to navigate up in the navigation hierarchy. Cmn android open Boolean @MainThread popBackStack() Attempts to pop the controller's back stack. Cmn 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. Cmn 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. Cmn 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. Cmn android Boolean @MainThread popBackStack(route: String, inclusive: Boolean, saveState: Boolean) Attempts to pop the controller's back stack back to a specific destination. Cmn android open Unit removeOnDestinationChangedListener(     listener: NavController.OnDestinationChangedListener ) Removes an OnDestinationChangedListener from this controller. Cmn android open Unit @CallSuper restoreState(navState: SavedState?) Restores all navigation controller state from a SavedState. Cmn android open SavedState? @CallSuper saveState() Saves all navigation controller state to a SavedState. Cmn android open Unit @MainThread @CallSuper setGraph(graphResId: @NavigationRes Int) Sets the navigation graph to the specified resource. android open Unit @MainThread @CallSuper setGraph(graph: NavGraph, startDestinationArgs: SavedState?) Sets the navigation graph to the specified graph. Cmn android open Unit @MainThread @CallSuper setGraph(graphResId: @NavigationRes Int, startDestinationArgs: Bundle?) Sets the navigation graph to the specified resource. android

Inherited properties

From androidx.navigation.NavController open NavBackStackEntry? currentBackStackEntry The topmost NavBackStackEntry. Cmn android Flow<NavBackStackEntry> currentBackStackEntryFlow A Flow that will emit the currently active NavBackStackEntry whenever it changes. Cmn android open NavDestination? currentDestination The current destination. Cmn android open NavGraph graph The topmost navigation graph associated with this NavController. Cmn android open NavInflater navInflater The inflater for this controller. android open NavigatorProvider navigatorProvider The NavController's NavigatorProvider. Cmn android open NavBackStackEntry? previousBackStackEntry The previous visible NavBackStackEntry. Cmn android StateFlow<List<NavBackStackEntry>> visibleEntries A StateFlow that will emit the currently visible NavBackStackEntries whenever they change. Cmn android

Public constructors

NavHostController

android

NavHostController()

NavHostController

android

Added in 2.1.0

NavHostController(context: Context)

Parameters
context: Context	context for this controller

Public functions

enableOnBackPressed

android

Added in 2.1.0

final fun enableOnBackPressed(enabled: Boolean): Unit

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

Parameters
enabled: Boolean	True if the NavController should handle system Back button events.

setLifecycleOwner

Cmn android

Added in 2.1.0

final fun setLifecycleOwner(owner: LifecycleOwner): Unit

Sets the host's LifecycleOwner.

Parameters
owner: LifecycleOwner	The LifecycleOwner associated with the containing NavHost.

setOnBackPressedDispatcher

android

Added in 2.1.0

final fun setOnBackPressedDispatcher(dispatcher: OnBackPressedDispatcher): Unit

Sets the host's OnBackPressedDispatcher. If set, NavController will register a onBackPressedCallback to handle system Back button events.

You must explicitly called setLifecycleOwner before calling this method as the owner set there will be used as the LifecycleOwner for registering the onBackPressedCallback.

You can dynamically enable and disable whether the NavController should handle the system Back button events by calling enableOnBackPressed.

Parameters
dispatcher: OnBackPressedDispatcher	The OnBackPressedDispatcher associated with the containing NavHost.

Throws
kotlin.IllegalStateException	if you have not called setLifecycleOwner before calling this method.

See also
setLifecycleOwner

setViewModelStore

Cmn android

Added in 2.1.0

final fun setViewModelStore(viewModelStore: ViewModelStore): Unit

Sets the host's ViewModelStore used by the NavController to store ViewModels at the navigation graph level. This is required to call getViewModelStoreOwner and should generally be called for you by your NavHost.

You must call this method before setGraph or similar methods, because the ViewModelStore set here will be used by the created NavBackStackEntry items.

Parameters
viewModelStore: ViewModelStore	ViewModelStore used to store ViewModels at the navigation graph level

Throws
kotlin.IllegalStateException	if this method is called when graph was already set via setGraph or similar methods.