NavController

public static final @NonNull String KEY_DEEP_LINK_INTENT

The Intent that triggered a deep link to the current destination.

public void addOnDestinationChangedListener(
    @NonNull NavController.OnDestinationChangedListener listener
)

Adds an OnDestinationChangedListener to this controller to receive a callback whenever the currentDestination or its arguments change.

The current destination, if any, will be immediately sent to your listener.

@MainThread
public final boolean <T extends Object> clearBackStack()

Clears any saved state associated with KClass T that was previously saved via popBackStack when using a saveState value of true.

@MainThread
public final boolean clearBackStack(@IdRes int destinationId)

Clears any saved state associated with destinationId that was previously saved via popBackStack when using a saveState value of true.

@MainThread
public final boolean <T extends Object> clearBackStack(@NonNull KClass<@NonNull T> route)

Clears any saved state associated with KClass route that was previously saved via popBackStack when using a saveState value of true.

@MainThread
public final boolean <T extends Object> clearBackStack(@NonNull T route)

Clears any saved state associated with KClass T that was previously saved via popBackStack when using a saveState value of true.

@MainThread
public final boolean clearBackStack(@NonNull String route)

Clears any saved state associated with route that was previously saved via popBackStack when using a saveState value of true.

public @NonNull NavDeepLinkBuilder createDeepLink()

Create a deep link to a destination within this NavController.

@NavDeepLinkSaveStateControl
public static final void enableDeepLinkSaveState(boolean saveState)

By default, handleDeepLink will automatically add calls to NavOptions.Builder.setPopUpTo with a saveState of true when the deep link takes you to another graph (e.g., a different navigation graph than the one your start destination is in).

You can disable this behavior by passing false for saveState.

public final @NonNull NavBackStackEntry <T extends Object> getBackStackEntry()

Gets the topmost NavBackStackEntry for a route from KClass.

This is always safe to use with the current destination or its parent or grandparent navigation graphs as these destinations are guaranteed to be on the back stack.

public @NonNull NavBackStackEntry getBackStackEntry(@IdRes int destinationId)

Gets the topmost NavBackStackEntry for a destination id.

This is always safe to use with the current destination or its parent or grandparent navigation graphs as these destinations are guaranteed to be on the back stack.

public final @NonNull NavBackStackEntry <T extends Object> getBackStackEntry(@NonNull KClass<@NonNull T> route)

Gets the topmost NavBackStackEntry for a route from KClass.

This is always safe to use with the current destination or its parent or grandparent navigation graphs as these destinations are guaranteed to be on the back stack.

public final @NonNull NavBackStackEntry <T extends Object> getBackStackEntry(@NonNull T route)

Gets the topmost NavBackStackEntry for a route from an Object.

This is always safe to use with the current destination or its parent or grandparent navigation graphs as these destinations are guaranteed to be on the back stack.

public final @NonNull NavBackStackEntry getBackStackEntry(@NonNull String route)

Gets the topmost NavBackStackEntry for a route.

This is always safe to use with the current destination or its parent or grandparent navigation graphs as these destinations are guaranteed to be on the back stack.

public NavBackStackEntry getCurrentBackStackEntry()

The topmost NavBackStackEntry.

public final @NonNull Flow<@NonNull NavBackStackEntry> getCurrentBackStackEntryFlow()

A Flow that will emit the currently active NavBackStackEntry whenever it changes. If there is no active NavBackStackEntry, no item will be emitted.

public NavDestination getCurrentDestination()

The current destination.

@MainThread
public @NonNull NavGraph getGraph()

The topmost navigation graph associated with this NavController.

When this is set any current navigation graph data (including back stack) will be replaced.

public @NonNull NavInflater getNavInflater()

The inflater for this controller.

public @NonNull NavigatorProvider getNavigatorProvider()

The NavController's NavigatorProvider. All Navigators used to construct the navigation graph for this nav controller should be added to this navigator provider before the graph is constructed.

This can only be set before the graph is set via setGraph().

Generally, the Navigators are set for you by the NavHost hosting this NavController and you do not need to manually interact with the navigator provider.

public NavBackStackEntry getPreviousBackStackEntry()

The previous visible NavBackStackEntry.

This skips over any NavBackStackEntry that is associated with a NavGraph.

public @NonNull ViewModelStoreOwner getViewModelStoreOwner(@IdRes int navGraphId)

Gets the ViewModelStoreOwner for a NavGraph. This can be passed to androidx.lifecycle.ViewModelProvider to retrieve a ViewModel that is scoped to the navigation graph - it will be cleared when the navigation graph is popped off the back stack.

public final @NonNull StateFlow<@NonNull List<@NonNull NavBackStackEntry>> getVisibleEntries()

A StateFlow that will emit the currently visible NavBackStackEntries whenever they change. If there is no visible NavBackStackEntry, this will be set to an empty list.

• CREATED entries are listed first and include all entries that are in the process of completing their exit transition. Note that this can include entries that have been popped off the Navigation back stack.

• STARTED entries on the back stack are next and include all entries that are running their enter transition and entries whose destination is partially covered by a FloatingWindow destination

• The last entry in the list is the topmost entry in the back stack and is in the RESUMED state only if its enter transition has completed. Otherwise it too will be STARTED.

Note that the Lifecycle of any entry cannot be higher than the containing Activity/Fragment - if the Activity is not RESUMED, no entry will be RESUMED, no matter what the transition state is.

@MainThread
public boolean handleDeepLink(Intent intent)

Checks the given Intent for a Navigation deep link and navigates to the deep link if present. This is called automatically for you the first time you set the graph if you've passed in an Activity as the context when constructing this NavController, but should be manually called if your Activity receives new Intents in Activity.onNewIntent.

The types of Intents that are supported include:

Intents created by NavDeepLinkBuilder or createDeepLink. This assumes that the current graph shares the same hierarchy to get to the deep linked destination as when the deep link was constructed. Intents that include a data Uri. This Uri will be checked against the Uri patterns in the NavDeepLinks added via NavDestination.addDeepLink.

The navigation graph should be set before calling this method.

@MainThread
public final boolean handleDeepLink(@NonNull NavDeepLinkRequest request)

Checks the given NavDeepLinkRequest for a Navigation deep link and navigates to the destination if present.

The navigation graph should be set before calling this method.

@MainThread
public void navigate(@NonNull NavUri deepLink)

Navigate to a destination via the given deep link Uri. NavDestination.hasDeepLink should be called on the navigation graph prior to calling this method to check if the deep link is valid. If an invalid deep link is given, an IllegalArgumentException will be thrown.

@MainThread
public void navigate(@NonNull NavDirections directions)

Navigate via the given NavDirections

@MainThread
public void navigate(@NonNull NavDeepLinkRequest request)

Navigate to a destination via the given NavDeepLinkRequest. NavDestination.hasDeepLink should be called on the navigation graph prior to calling this method to check if the deep link is valid. If an invalid deep link is given, an IllegalArgumentException will be thrown.

@MainThread
public void navigate(@IdRes int resId)

Navigate to a destination from the current navigation graph. This supports both navigating via an action and directly navigating to a destination.

@MainThread
public void navigate(@NonNull NavUri deepLink, NavOptions navOptions)

Navigate to a destination via the given deep link Uri. NavDestination.hasDeepLink should be called on the navigation graph prior to calling this method to check if the deep link is valid. If an invalid deep link is given, an IllegalArgumentException will be thrown.

@MainThread
public void navigate(@NonNull NavDirections directions, NavOptions navOptions)

Navigate via the given NavDirections

@MainThread
public void navigate(
    @NonNull NavDirections directions,
    @NonNull Navigator.Extras navigatorExtras
)

Navigate via the given NavDirections

@MainThread
public void navigate(@NonNull NavDeepLinkRequest request, NavOptions navOptions)

Navigate to a destination via the given NavDeepLinkRequest. NavDestination.hasDeepLink should be called on the navigation graph prior to calling this method to check if the deep link is valid. If an invalid deep link is given, an IllegalArgumentException will be thrown.

@MainThread
public void navigate(@IdRes int resId, Bundle args)

Navigate to a destination from the current navigation graph. This supports both navigating via an action and directly navigating to a destination.

@MainThread
public final void <T extends Object> navigate(
    @NonNull T route,
    @NonNull Function1<@NonNull NavOptionsBuilder, Unit> builder
)

Navigate to a route from an Object in the current NavGraph. If an invalid route is given, an IllegalArgumentException will be thrown.

The target NavDestination must have been created with route from a KClass

If given NavOptions pass in NavOptions.restoreState true, any args passed here as part of the route will be overridden by the restored args.

@MainThread
public final void navigate(
    @NonNull String route,
    @NonNull Function1<@NonNull NavOptionsBuilder, Unit> builder
)

Navigate to a route in the current NavGraph. If an invalid route is given, an IllegalArgumentException will be thrown.

If given NavOptions pass in NavOptions.restoreState true, any args passed here as part of the route will be overridden by the restored args.

@MainThread
public void navigate(
    @NonNull NavUri deepLink,
    NavOptions navOptions,
    Navigator.Extras navigatorExtras
)

Navigate to a destination via the given deep link Uri. NavDestination.hasDeepLink should be called on the navigation graph prior to calling this method to check if the deep link is valid. If an invalid deep link is given, an IllegalArgumentException will be thrown.

@MainThread
public void navigate(
    @NonNull NavDeepLinkRequest request,
    NavOptions navOptions,
    Navigator.Extras navigatorExtras
)

Navigate to a destination via the given NavDeepLinkRequest. NavDestination.hasDeepLink should be called on the navigation graph prior to calling this method to check if the deep link is valid. If an invalid deep link is given, an IllegalArgumentException will be thrown.

@MainThread
public void navigate(@IdRes int resId, Bundle args, NavOptions navOptions)

Navigate to a destination from the current navigation graph. This supports both navigating via an action and directly navigating to a destination.

If given NavOptions pass in NavOptions.restoreState true, any args passed here will be overridden by the restored args.

@MainThread
public final void <T extends Object> navigate(
    @NonNull T route,
    NavOptions navOptions,
    Navigator.Extras navigatorExtras
)

Navigate to a route from an Object in the current NavGraph. If an invalid route is given, an IllegalArgumentException will be thrown.

The target NavDestination must have been created with route from a KClass

If given NavOptions pass in NavOptions.restoreState true, any args passed here as part of the route will be overridden by the restored args.

@MainThread
public final void navigate(
    @NonNull String route,
    NavOptions navOptions,
    Navigator.Extras navigatorExtras
)

Navigate to a route in the current NavGraph. If an invalid route is given, an IllegalArgumentException will be thrown.

If given NavOptions pass in NavOptions.restoreState true, any args passed here as part of the route will be overridden by the restored args.

@MainThread
public void navigate(
    @IdRes int resId,
    Bundle args,
    NavOptions navOptions,
    Navigator.Extras navigatorExtras
)

Navigate to a destination from the current navigation graph. This supports both navigating via an action and directly navigating to a destination.

If given NavOptions pass in NavOptions.restoreState true, any args passed here will be overridden by the restored args.

@MainThread
public boolean navigateUp()

Attempts to navigate up in the navigation hierarchy. Suitable for when the user presses the "Up" button marked with a left (or start)-facing arrow in the upper left (or starting) corner of the app UI.

The intended behavior of Up differs from Back when the user did not reach the current destination from the application's own task. e.g. if the user is viewing a document or link in the current app in an activity hosted on another app's task where the user clicked the link. In this case the current activity (determined by the context used to create this NavController) will be Activity.finish and the user will be taken to an appropriate destination in this app on its own task.

@MainThread
public boolean popBackStack()

Attempts to pop the controller's back stack. Analogous to when the user presses the system android.view.KeyEvent.KEYCODE_BACK button when the associated navigation host has focus.

@MainThread
public boolean popBackStack(@IdRes int destinationId, boolean inclusive)

Attempts to pop the controller's back stack back to a specific destination.

@MainThread
public final boolean <T extends Object> popBackStack(boolean inclusive, boolean saveState)

Attempts to pop the controller's back stack back to a specific destination.

@MainThread
public boolean popBackStack(
    @IdRes int destinationId,
    boolean inclusive,
    boolean saveState
)

Attempts to pop the controller's back stack back to a specific destination.

@MainThread
public final boolean <T extends Object> popBackStack(
    @NonNull KClass<@NonNull T> route,
    boolean inclusive,
    boolean saveState
)

Attempts to pop the controller's back stack back to a specific destination.

@MainThread
public final boolean <T extends Object> popBackStack(
    @NonNull T route,
    boolean inclusive,
    boolean saveState
)

Attempts to pop the controller's back stack back to a specific destination.

@MainThread
public final boolean popBackStack(@NonNull String route, boolean inclusive, boolean saveState)

Attempts to pop the controller's back stack back to a specific destination.

public void removeOnDestinationChangedListener(
    @NonNull NavController.OnDestinationChangedListener listener
)

Removes an OnDestinationChangedListener from this controller. It will no longer receive callbacks.

@CallSuper
public void restoreState(SavedState navState)

Restores all navigation controller state from a SavedState. This should be called before any call to setGraph.

State may be saved to a SavedState by calling saveState. Restoring controller state is the responsibility of a NavHost.

@CallSuper
public SavedState saveState()

Saves all navigation controller state to a SavedState.

State may be restored from a SavedState returned from this method by calling restoreState. Saving controller state is the responsibility of a NavHost.

@MainThread
@CallSuper
public void setGraph(@NonNull NavGraph graph)

The topmost navigation graph associated with this NavController.

When this is set any current navigation graph data (including back stack) will be replaced.

@MainThread
@CallSuper
public void setGraph(@NavigationRes int graphResId)

Sets the navigation graph to the specified resource. Any current navigation graph data (including back stack) will be replaced.

The inflated graph can be retrieved via graph.

@MainThread
@CallSuper
public void setGraph(@NonNull NavGraph graph, SavedState startDestinationArgs)

Sets the navigation graph to the specified graph. Any current navigation graph data (including back stack) will be replaced.

The graph can be retrieved later via graph.

@MainThread
@CallSuper
public void setGraph(@NavigationRes int graphResId, Bundle startDestinationArgs)

Sets the navigation graph to the specified resource. Any current navigation graph data (including back stack) will be replaced.

The inflated graph can be retrieved via graph.

public final @NonNull NavGraph NavControllerKt.createGraph(
    @NonNull NavController receiver,
    @IdRes int id,
    @IdRes int startDestination,
    @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder
)

Construct a new NavGraph

public final @NonNull NavGraph NavControllerKt.createGraph(
    @NonNull NavController receiver,
    @IdRes int id,
    @IdRes int startDestination,
    @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

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

public final @NonNull NavGraph NavControllerKt.createGraph(
    @NonNull NavController receiver,
    @NonNull String startDestination,
    String route,
    @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder
)

Construct a new NavGraph

public final @NonNull NavGraph NavControllerKt.createGraph(
    @NonNull NavController receiver,
    @NonNull String startDestination,
    String route,
    @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

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

public final @NonNull NavGraph NavControllerKt.createGraph(
    @NonNull NavController receiver,
    @NonNull Object startDestination,
    KClass<@NonNull ?> route,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder
)

Construct a new NavGraph

public final @NonNull NavGraph NavControllerKt.createGraph(
    @NonNull NavController receiver,
    @NonNull Object startDestination,
    KClass<@NonNull ?> route,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

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

public final @NonNull NavGraph NavControllerKt.createGraph(
    @NonNull NavController receiver,
    @NonNull KClass<@NonNull ?> startDestination,
    KClass<@NonNull ?> route,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder
)

Construct a new NavGraph

public final @NonNull NavGraph NavControllerKt.createGraph(
    @NonNull NavController receiver,
    @NonNull KClass<@NonNull ?> startDestination,
    KClass<@NonNull ?> route,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)

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

public final boolean NavControllerKt.navigateUp(
    @NonNull NavController receiver,
    @NonNull AppBarConfiguration appBarConfiguration
)

Handles the Up button by delegating its behavior to the given NavController.

public final boolean NavControllerKt.navigateUp(
    @NonNull NavController receiver,
    Openable drawerLayout
)

Handles the Up button by delegating its behavior to the given NavController.

This is equivalent to calling NavController.navigateUp if the Openable layout is null.