androidx.navigation
Interfaces
FloatingWindow |
A marker interface for |
NavArgs |
An interface marking generated Args classes. |
OnDestinationChangedListener |
OnDestinationChangedListener receives a callback when the |
NavDirections |
An interface that describes a navigation operation: action's id and arguments |
NavHost |
A host is a single context or container for navigation via a |
Extras |
Interface indicating that this class should be passed to its respective |
Classes
ActionOnlyNavDirections |
An implementation of |
ActivityNavigator |
ActivityNavigator implements cross-activity navigation. |
ActivityNavigatorDestinationBuilder |
DSL for constructing a new ActivityNavigator.Destination |
AnimBuilder |
DSL for setting custom Animation or Animator resources on a NavOptionsBuilder |
NavAction |
Navigation actions provide a level of indirection between your navigation code and the underlying destinations. |
NavActionBuilder |
DSL for building a NavAction. |
NavArgsLazy |
An implementation of Lazy used by android.app.Activity.navArgs and androidx.fragment.app.Fragment.navArgs. |
NavArgument |
NavArgument denotes an argument that is supported by a |
NavArgumentBuilder |
DSL for constructing a new NavArgument |
NavBackStackEntry |
Representation of an entry in the back stack of a |
NavController |
NavController manages app navigation within a |
NavDeepLink |
NavDeepLink encapsulates the parsing and matching of a navigation deep link. |
NavDeepLinkBuilder |
Class used to construct deep links to a particular destination in a |
NavDeepLinkDslBuilder |
DSL for constructing a new NavDeepLink |
NavDeepLinkRequest |
A request for a deep link in a |
NavDestination |
NavDestination represents one node within an overall navigation graph. |
NavDestinationBuilder |
DSL for constructing a new NavDestination |
NavGraph |
NavGraph is a collection of |
NavGraphBuilder |
DSL for constructing a new NavGraph |
NavGraphNavigator |
A Navigator built specifically for |
NavHostController |
Subclass of |
Navigation |
Entry point for navigation operations. |
Navigator |
Navigator defines a mechanism for navigating within an app. |
NavigatorProvider |
A NavigationProvider stores a set of |
NavInflater |
Class which translates a navigation XML file into a |
NavOptions |
NavOptions stores special options for navigate actions |
NavOptionsBuilder |
DSL for constructing a new NavOptions |
NavType |
NavType denotes the type that can be used in a |
PopUpToBuilder |
DSL for customizing NavOptionsBuilder.popUpTo operations. |
Annotations
NavDeepLinkDsl | |
NavDestinationDsl | |
NavOptionsDsl |
Top-level functions summary
ActivityNavigator.Extras |
ActivityNavigatorExtras(: ActivityOptionsCompat? = null, : Int = 0) Create a new ActivityNavigator.Extras instance with a specific ActivityOptionsCompat
instance and/or any |
NavDeepLink |
navDeepLink(: NavDeepLinkDslBuilder.() -> Unit) Construct a new NavDeepLink |
NavOptions |
navOptions(: NavOptionsBuilder.() -> Unit) Construct a new NavOptions |
Extension functions summary
For android.app.Activity | |
NavController |
Activity.findNavController(@IdRes : Int) Find a NavController given the id of a View and its containing Activity. |
NavArgsLazy<Args> |
Returns a Lazy delegate to access the Activity's extras as an Args instance. |
For android.view.View | |
NavController |
Find a NavController associated with a View. |
For NavGraphBuilder | |
Unit |
NavGraphBuilder.activity(@IdRes : Int, : ActivityNavigatorDestinationBuilder.() -> Unit) Construct a new ActivityNavigator.Destination |
Unit |
NavGraphBuilder.navigation(@IdRes : Int, @IdRes : Int, : NavGraphBuilder.() -> Unit) Construct a nested NavGraph |
For NavGraph | |
operator Boolean |
Returns |
operator NavDestination |
Returns the destination with |
operator Unit |
Removes |
operator Unit |
Adds a destination to this NavGraph. |
operator Unit |
Add all destinations from another collection to this one. |
For NavController | |
NavGraph |
NavController.createGraph(@IdRes : Int = 0, @IdRes : Int, : NavGraphBuilder.() -> Unit) Construct a new NavGraph |
For NavHost | |
NavGraph |
NavHost.createGraph(@IdRes : Int = 0, @IdRes : Int, : NavGraphBuilder.() -> Unit) Construct a new NavGraph |
For NavigatorProvider | |
operator T |
Retrieves a registered Navigator by name. |
operator T |
NavigatorProvider.get(: KClass<T>) Retrieves a registered Navigator using the name provided by the Navigator.Name annotation. |
NavGraph |
NavigatorProvider.navigation(@IdRes : Int = 0, @IdRes : Int, : NavGraphBuilder.() -> Unit) Construct a new NavGraph |
operator Unit |