NavController
public class NavController
NavHostController |
Subclass of |
TestNavHostController |
Subclass of |
NavController manages app navigation within a NavHost.
Apps will generally obtain a controller directly from a host, or by using one of the utility methods on the Navigation class rather than create a controller directly.
Navigation flows and destinations are determined by the navigation graph owned by the controller. These graphs are typically navInflater from an Android resource, but, like views, they can also be constructed or combined programmatically or for the case of dynamic navigation structure. (For example, if the navigation structure of the application is determined by live data obtained' from a remote server.)
Summary
Nested types |
|---|
public fun interface NavController.OnDestinationChangedListenerOnDestinationChangedListener receives a callback when the |
Public constructors |
|---|
Public methods |
|
|---|---|
void |
Adds an |
final boolean |
@MainThreadClears any saved state associated with KClass |
final boolean |
@MainThreadClears any saved state associated with KClass |
final boolean |
@MainThreadClears any saved state associated with KClass |
final boolean |
@MainThreadClears any saved state associated with |
static final void |
@NavDeepLinkSaveStateControlBy default, |
final @NonNull NavBackStackEntry |
<T extends Object> getBackStackEntry()Gets the topmost |
final @NonNull NavBackStackEntry |
<T extends Object> getBackStackEntry(@NonNull KClass<@NonNull T> route)Gets the topmost |
final @NonNull NavBackStackEntry |
<T extends Object> getBackStackEntry(@NonNull T route)Gets the topmost |
final @NonNull NavBackStackEntry |
getBackStackEntry(@NonNull String route)Gets the topmost |
NavBackStackEntry |
The topmost |
final @NonNull Flow<@NonNull NavBackStackEntry> |
A |
NavDestination |
The current destination. |
@NonNull NavGraph |
The topmost navigation graph associated with this NavController. |
@NonNull NavigatorProvider |
The NavController's |
NavBackStackEntry |
The previous visible |
final @NonNull StateFlow<@NonNull List<@NonNull NavBackStackEntry>> |
A |
final boolean |
@MainThreadChecks the given NavDeepLinkRequest for a Navigation deep link and navigates to the destination if present. |
void |
@MainThreadNavigate to a destination via the given deep link Uri. |
void |
@MainThreadNavigate to a destination via the given |
void |
@MainThreadNavigate to a destination via the given deep link Uri. |
void |
@MainThreadNavigate to a destination via the given |
final void |
@MainThreadNavigate to a route from an Object in the current NavGraph. |
final void |
@MainThreadNavigate to a route in the current NavGraph. |
void |
@MainThreadNavigate to a destination via the given deep link Uri. |
void |
@MainThreadNavigate to a destination via the given |
final void |
@MainThreadNavigate to a route from an Object in the current NavGraph. |
final void |
@MainThreadNavigate to a route in the current NavGraph. |
boolean |
Attempts to navigate up in the navigation hierarchy. |
boolean |
Attempts to pop the controller's back stack. |
final boolean |
@MainThreadAttempts to pop the controller's back stack back to a specific destination. |
final boolean |
@MainThreadAttempts to pop the controller's back stack back to a specific destination. |
final boolean |
@MainThreadAttempts to pop the controller's back stack back to a specific destination. |
final boolean |
@MainThreadAttempts to pop the controller's back stack back to a specific destination. |
void |
Removes an |
void |
@CallSuperRestores all navigation controller state from a SavedState. |
SavedState |
Saves all navigation controller state to a SavedState. |
void |
@MainThreadThe topmost navigation graph associated with this NavController. |
void |
@MainThreadSets the |
Public constructors
Public methods
addOnDestinationChangedListener
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.
| Parameters | |
|---|---|
@NonNull NavController.OnDestinationChangedListener listener |
the listener to receive events |
clearBackStack
@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.
| Parameters | |
|---|---|
<T extends Object> |
The route from the |
| Returns | |
|---|---|
boolean |
true if the saved state of the stack associated with |
clearBackStack
@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.
| Parameters | |
|---|---|
@NonNull KClass<@NonNull T> route |
The route from the |
| Returns | |
|---|---|
boolean |
true if the saved state of the stack associated with |
clearBackStack
@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.
| Parameters | |
|---|---|
@NonNull T route |
The route from an Object of the destination previously used with |
| Returns | |
|---|---|
boolean |
true if the saved state of the stack associated with |
clearBackStack
@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.
| Parameters | |
|---|---|
@NonNull String route |
The route of the destination previously used with |
| Returns | |
|---|---|
boolean |
true if the saved state of the stack associated with |
enableDeepLinkSaveState
@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.
getBackStackEntry
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.
| Parameters | |
|---|---|
<T extends Object> |
route from the |
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if the destination is not on the back stack |
getBackStackEntry
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.
| Parameters | |
|---|---|
@NonNull KClass<@NonNull T> route |
route from the |
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if the destination is not on the back stack |
getBackStackEntry
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.
| Parameters | |
|---|---|
@NonNull T route |
route from an Object of a destination that exists on the back stack. The target NavBackStackEntry's |
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if the destination is not on the back stack |
getBackStackEntry
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.
| Parameters | |
|---|---|
@NonNull String route |
route of a destination that exists on the back stack. May contain filled in arguments as long as it is exact match with route used to navigate. |
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if the destination is not on the back stack |
getCurrentBackStackEntry
public NavBackStackEntry getCurrentBackStackEntry()
The topmost NavBackStackEntry.
| Returns | |
|---|---|
NavBackStackEntry |
the topmost entry on the back stack or null if the back stack is empty |
getCurrentBackStackEntryFlow
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.
getCurrentDestination
public NavDestination getCurrentDestination()
The current destination.
getGraph
@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.
| Throws | |
|---|---|
kotlin.IllegalStateException |
if called before |
| See also | |
|---|---|
setGraph |
getNavigatorProvider
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.
| Throws | |
|---|---|
kotlin.IllegalStateException |
If this set called after |
getPreviousBackStackEntry
public NavBackStackEntry getPreviousBackStackEntry()
The previous visible NavBackStackEntry.
This skips over any NavBackStackEntry that is associated with a NavGraph.
| Returns | |
|---|---|
NavBackStackEntry |
the previous visible entry on the back stack or null if the back stack has less than two visible entries |
getVisibleEntries
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.
-
CREATEDentries 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. -
STARTEDentries on the back stack are next and include all entries that are running their enter transition and entries whose destination is partially covered by aFloatingWindowdestination -
The last entry in the list is the topmost entry in the back stack and is in the
RESUMEDstate only if its enter transition has completed. Otherwise it too will beSTARTED.
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.
handleDeepLink
@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.
| Parameters | |
|---|---|
@NonNull NavDeepLinkRequest request |
The request that contains a valid deep link, an action or a mimeType. |
| Returns | |
|---|---|
boolean |
True if the navigation controller found a valid deep link and navigated to it. |
| Throws | |
|---|---|
kotlin.IllegalStateException |
if deep link cannot be accessed from the current destination |
| See also | |
|---|---|
addDeepLink |
navigate
@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.
| See also | |
|---|---|
navigate |
navigate
@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.
| Parameters | |
|---|---|
@NonNull NavDeepLinkRequest request |
deepLinkRequest to the destination reachable from the current NavGraph |
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if the given deep link request is invalid |
navigate
@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.
| Parameters | |
|---|---|
@NonNull NavUri deepLink |
deepLink to the destination reachable from the current NavGraph |
NavOptions navOptions |
special options for this navigation operation |
| See also | |
|---|---|
navigate |
navigate
@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.
| Parameters | |
|---|---|
@NonNull NavDeepLinkRequest request |
deepLinkRequest to the destination reachable from the current NavGraph |
NavOptions navOptions |
special options for this navigation operation |
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if the given deep link request is invalid |
navigate
@MainThread
public final void <T extends Object> navigate(
@NonNull T route,
@ExtensionFunctionType @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.
| Parameters | |
|---|---|
@NonNull T route |
route from an Object for the destination |
@ExtensionFunctionType @NonNull Function1<@NonNull NavOptionsBuilder, Unit> builder |
DSL for constructing a new |
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if the given route is invalid |
navigate
@MainThread
public final void navigate(
@NonNull String route,
@ExtensionFunctionType @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.
| Parameters | |
|---|---|
@NonNull String route |
route for the destination |
@ExtensionFunctionType @NonNull Function1<@NonNull NavOptionsBuilder, Unit> builder |
DSL for constructing a new |
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if the given route is invalid |
navigate
@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.
| Parameters | |
|---|---|
@NonNull NavUri deepLink |
deepLink to the destination reachable from the current NavGraph |
NavOptions navOptions |
special options for this navigation operation |
Navigator.Extras navigatorExtras |
extras to pass to the Navigator |
| See also | |
|---|---|
navigate |
navigate
@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.
| Parameters | |
|---|---|
@NonNull NavDeepLinkRequest request |
deepLinkRequest to the destination reachable from the current NavGraph |
NavOptions navOptions |
special options for this navigation operation |
Navigator.Extras navigatorExtras |
extras to pass to the Navigator |
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if the given deep link request is invalid |
navigate
@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.
| Parameters | |
|---|---|
@NonNull T route |
route from an Object for the destination |
NavOptions navOptions |
special options for this navigation operation |
Navigator.Extras navigatorExtras |
extras to pass to the |
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if the given route is invalid |
navigate
@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.
| Parameters | |
|---|---|
@NonNull String route |
route for the destination |
NavOptions navOptions |
special options for this navigation operation |
Navigator.Extras navigatorExtras |
extras to pass to the |
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if the given route is invalid |
navigateUp
@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.
| Returns | |
|---|---|
boolean |
true if navigation was successful, false otherwise |
popBackStack
@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.
| Returns | |
|---|---|
boolean |
true if the stack was popped at least once and the user has been navigated to another destination, false otherwise |
popBackStack
@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.
| Parameters | |
|---|---|
<T extends Object> |
The topmost destination to retain with route from a |
boolean inclusive |
Whether the given destination should also be popped. |
boolean saveState |
Whether the back stack and the state of all destinations between the current destination and |
| Returns | |
|---|---|
boolean |
true if the stack was popped at least once and the user has been navigated to another destination, false otherwise |
popBackStack
@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.
| Parameters | |
|---|---|
@NonNull KClass<@NonNull T> route |
The topmost destination to retain with route from a |
boolean inclusive |
Whether the given destination should also be popped. |
boolean saveState |
Whether the back stack and the state of all destinations between the current destination and |
| Returns | |
|---|---|
boolean |
true if the stack was popped at least once and the user has been navigated to another destination, false otherwise |
popBackStack
@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.
| Parameters | |
|---|---|
@NonNull T route |
The topmost destination to retain with route from an Object. The target NavDestination must have been created with route from |
boolean inclusive |
Whether the given destination should also be popped. |
boolean saveState |
Whether the back stack and the state of all destinations between the current destination and the |
| Returns | |
|---|---|
boolean |
true if the stack was popped at least once and the user has been navigated to another destination, false otherwise |
popBackStack
@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.
| Parameters | |
|---|---|
@NonNull String route |
The topmost destination to retain. May contain filled in arguments as long as it is exact match with route used to navigate. |
boolean inclusive |
Whether the given destination should also be popped. |
boolean saveState |
Whether the back stack and the state of all destinations between the current destination and the |
| Returns | |
|---|---|
boolean |
true if the stack was popped at least once and the user has been navigated to another destination, false otherwise |
removeOnDestinationChangedListener
public void removeOnDestinationChangedListener(
@NonNull NavController.OnDestinationChangedListener listener
)
Removes an OnDestinationChangedListener from this controller. It will no longer receive callbacks.
| Parameters | |
|---|---|
@NonNull NavController.OnDestinationChangedListener listener |
the listener to remove |
restoreState
@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.
| Parameters | |
|---|---|
SavedState navState |
SavedState to restore |
saveState
@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.
| Returns | |
|---|---|
SavedState |
saved state for this controller |
setGraph
@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.
| Throws | |
|---|---|
kotlin.IllegalStateException |
if called before |
| See also | |
|---|---|
setGraph |
setGraph
@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.
| Parameters | |
|---|---|
@NonNull NavGraph graph |
graph to set |
SavedState startDestinationArgs |
arguments to send to the start destination of the graph |
Extension functions
NavControllerKt.createGraph
public final @NonNull NavGraph NavControllerKt.createGraph(
@NonNull NavController receiver,
@IdRes int id,
@IdRes int startDestination,
@ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder
)
Construct a new NavGraph
| Parameters | |
|---|---|
@IdRes int id |
the graph's unique id |
@IdRes int startDestination |
the route for the start destination |
@ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder |
the builder used to construct the graph |
NavControllerKt.createGraph
public final @NonNull NavGraph NavControllerKt.createGraph(
@NonNull NavController receiver,
@IdRes int id,
@IdRes int startDestination,
@ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)
Construct a new androidx.navigation.NavGraph that supports dynamic navigation destinations
NavControllerKt.createGraph
public final @NonNull NavGraph NavControllerKt.createGraph(
@NonNull NavController receiver,
@NonNull String startDestination,
String route,
@ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder
)
Construct a new NavGraph
| Parameters | |
|---|---|
@NonNull String startDestination |
the route for the start destination |
String route |
the route for the graph |
@ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder |
the builder used to construct the graph |
NavControllerKt.createGraph
public final @NonNull NavGraph NavControllerKt.createGraph(
@NonNull NavController receiver,
@NonNull String startDestination,
String route,
@ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)
Construct a new androidx.navigation.NavGraph that supports dynamic navigation destinations
NavControllerKt.createGraph
public final @NonNull NavGraph NavControllerKt.createGraph(
@NonNull NavController receiver,
@NonNull Object startDestination,
KClass<@NonNull ?> route,
@NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
@ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder
)
Construct a new NavGraph
| Parameters | |
|---|---|
@NonNull Object startDestination |
the starting destination's route from an Object for this NavGraph. The respective NavDestination must be added as a |
KClass<@NonNull ?> route |
the graph's unique route from a |
@NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap |
A mapping of KType to custom NavType<*> in the |
@ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder |
the builder used to construct the graph |
NavControllerKt.createGraph
public final @NonNull NavGraph NavControllerKt.createGraph(
@NonNull NavController receiver,
@NonNull Object startDestination,
KClass<@NonNull ?> route,
@NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
@ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)
Construct a new androidx.navigation.NavGraph that supports dynamic navigation destinations
| Parameters | |
|---|---|
@NonNull Object startDestination |
the starting destination's route from an Object for this NavGraph. The respective NavDestination must be added as a |
KClass<@NonNull ?> route |
the graph's unique route from a |
@NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap |
A mapping of KType to custom NavType<*> in the |
@ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder |
the builder used to construct the graph |
NavControllerKt.createGraph
public final @NonNull NavGraph NavControllerKt.createGraph(
@NonNull NavController receiver,
@NonNull KClass<@NonNull ?> startDestination,
KClass<@NonNull ?> route,
@NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
@ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder
)
Construct a new NavGraph
| Parameters | |
|---|---|
@NonNull KClass<@NonNull ?> startDestination |
the starting destination's route from a |
KClass<@NonNull ?> route |
the graph's unique route from a |
@NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap |
A mapping of KType to custom NavType<*> in the |
@ExtensionFunctionType @NonNull Function1<@NonNull NavGraphBuilder, Unit> builder |
the builder used to construct the graph |
NavControllerKt.createGraph
public final @NonNull NavGraph NavControllerKt.createGraph(
@NonNull NavController receiver,
@NonNull KClass<@NonNull ?> startDestination,
KClass<@NonNull ?> route,
@NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
@ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder
)
Construct a new androidx.navigation.NavGraph that supports dynamic navigation destinations
| Parameters | |
|---|---|
@NonNull KClass<@NonNull ?> startDestination |
the starting destination's route from a |
KClass<@NonNull ?> route |
the graph's unique route from a |
@NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap |
A mapping of KType to custom NavType<*> in the |
@ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilder, Unit> builder |
the builder used to construct the graph |
NavControllerKt.navigateUp
public final boolean NavControllerKt.navigateUp(
@NonNull NavController receiver,
@NonNull AppBarConfiguration appBarConfiguration
)
Handles the Up button by delegating its behavior to the given NavController.
| Returns | |
|---|---|
boolean |
True if the |
NavControllerKt.navigateUp
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.
| Returns | |
|---|---|
boolean |
True if the |