NavGraphNavigator

Artifact: androidx.navigation:navigation-common

View Source

Added in 1.0.0

---

Kotlin |Java

Common/AllAndroid/JVM

• android

  @Navigator.Name(value = "navigation")
  open class NavGraphNavigator : Navigator

kotlin.Any
↳	androidx.navigation.Navigator
	↳	androidx.navigation.NavGraphNavigator

---

A Navigator built specifically for NavGraph elements. Handles navigating to the correct destination when the NavGraph is the target of navigation actions.

Construct a Navigator capable of routing incoming navigation requests to the proper destination within a NavGraph.

Summary

Public constructors
NavGraphNavigator(navigatorProvider: NavigatorProvider)	android

Public functions
open NavGraph	createDestination() Creates a new NavGraph associated with this navigator.	android
open Unit	navigate(     entries: List<NavBackStackEntry>,     navOptions: NavOptions?,     navigatorExtras: Navigator.Extras? )	android

Public properties
StateFlow<List<NavBackStackEntry>>	backStack Gets the backstack of NavBackStackEntry associated with this Navigator	android

Inherited functions

From androidx.navigation.Navigator open NavDestination? navigate(     destination: NavGraph,     args: Bundle?,     navOptions: NavOptions?,     navigatorExtras: Navigator.Extras? ) Navigate to a destination. android open Unit @CallSuper onAttach(state: NavigatorState) Indicator that this Navigator is actively being used by a NavController. android open Unit onLaunchSingleTop(backStackEntry: NavBackStackEntry) Informational callback indicating that the given backStackEntry has been affected by a NavOptions.shouldLaunchSingleTop operation. android open Unit onRestoreState(savedState: Bundle) Restore any state previously saved in onSaveState. android open Bundle? onSaveState() Called to ask for a SavedState representing the Navigator's state. android open Boolean popBackStack() Attempt to pop this navigator's back stack, performing the appropriate navigation. android open Unit popBackStack(popUpTo: NavBackStackEntry, savedState: Boolean) Attempt to pop this navigator's back stack, performing the appropriate navigation. android

Inherited properties
From androidx.navigation.Navigator Boolean isAttached Whether this Navigator is actively being used by a NavController. android NavigatorState state The state of the Navigator is the communication conduit between the Navigator and the NavController that has called onAttach. android

Public constructors

NavGraphNavigator

android

Added in 1.0.0

NavGraphNavigator(navigatorProvider: NavigatorProvider)

Parameters
navigatorProvider: NavigatorProvider	NavigatorProvider used to retrieve the correct Navigator to navigate to the start destination

Public functions

createDestination

android

open fun createDestination(): NavGraph

Creates a new NavGraph associated with this navigator.

Returns
NavGraph	The created NavGraph.

navigate

android

open fun navigate(
    entries: List<NavBackStackEntry>,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
): Unit

Throws
kotlin.IllegalArgumentException	if given destination is not a child of the current navgraph

Public properties

backStack

android

Added in 2.6.0

val backStack: StateFlow<List<NavBackStackEntry>>

Gets the backstack of NavBackStackEntry associated with this Navigator