androidx.navigation

Annotations

NavDeepLinkDsl
NavDeepLinkSaveStateControl
NavDestination.ClassType

This optional annotation allows tooling to offer auto-complete for the android:name attribute.

NavDestinationDsl
NavOptionsDsl
Navigator.Name

This annotation should be added to each Navigator subclass to denote the default name used to register the Navigator with a NavigatorProvider.

Interfaces

FloatingWindow

A marker interface for NavDestination subclasses that float above the view of other destinations (i.e. androidx.navigation.fragment.DialogFragmentNavigator.Destination).

NavArgs

An interface marking generated Args classes.

NavController.OnDestinationChangedListener

OnDestinationChangedListener receives a callback when the currentDestination or its arguments change.

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 NavController.

Navigator.Extras

Interface indicating that this class should be passed to its respective Navigator to enable Navigator specific behavior.

Classes

ActionOnlyNavDirections

An implementation of NavDirections without any arguments.

ActivityKt
ActivityNavArgsLazyKt
ActivityNavigator

ActivityNavigator implements cross-activity navigation.

ActivityNavigator.Destination

NavDestination for activity navigation

ActivityNavigator.Extras

Extras that can be passed to ActivityNavigator to customize what ActivityOptionsCompat and flags are passed through to the call to ActivityCompat.startActivity.

ActivityNavigator.Extras.Builder

Builder for constructing new Extras instances.

ActivityNavigatorDestinationBuilder

DSL for constructing a new ActivityNavigator.Destination

ActivityNavigatorDestinationBuilderKt
ActivityNavigatorExtrasKt
AnimBuilder

DSL for setting custom Animation or Animator resources on a NavOptionsBuilder

NamedNavArgument

Construct a named NavArgument by using the navArgument method.

NamedNavArgumentKt
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 NavDestination.

NavArgument.Builder

A builder for constructing NavArgument instances.

NavArgumentBuilder

DSL for constructing a new NavArgument

NavBackStackEntry

Representation of an entry in the back stack of a androidx.navigation.NavController.

NavController

NavController manages app navigation within a NavHost.

NavControllerKt
NavDeepLink

NavDeepLink encapsulates the parsing and matching of a navigation deep link.

NavDeepLink.Builder

A builder for constructing NavDeepLink instances.

NavDeepLinkBuilder

Class used to construct deep links to a particular destination in a NavGraph.

NavDeepLinkDslBuilder

DSL for constructing a new NavDeepLink

NavDeepLinkDslBuilderKt
NavDeepLinkRequest

A request for a deep link in a NavDestination.

NavDeepLinkRequest.Builder

A builder for constructing NavDeepLinkRequest instances.

NavDestination

NavDestination represents one node within an overall navigation graph.

NavDestinationBuilder

DSL for constructing a new NavDestination

NavGraph

NavGraph is a collection of NavDestination nodes fetchable by ID.

NavGraphBuilder

DSL for constructing a new NavGraph

NavGraphBuilderKt
NavGraphKt
NavGraphNavigator

A Navigator built specifically for NavGraph elements.

NavGraphViewModelLazyKt
NavHostController

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

NavHostKt
NavInflater

Class which translates a navigation XML file into a NavGraph

NavOptions

NavOptions stores special options for navigate actions

NavOptions.Builder

Builder for constructing new instances of NavOptions.

NavOptionsBuilder

DSL for constructing a new NavOptions

NavOptionsBuilderKt
NavType

NavType denotes the type that can be used in a NavArgument.

NavType.EnumType

EnumType is used for NavArguments holding enum values.

NavType.ParcelableArrayType

ParcelableArrayType is used for NavArguments which hold arrays of Parcelables.

NavType.ParcelableType

ParcelableType is used for passing Parcelables in NavArguments.

NavType.SerializableArrayType

SerializableArrayType is used for NavArguments that hold arrays of Serializables.

NavType.SerializableType

SerializableType is used for Serializable NavArguments.

Navigator

Navigator defines a mechanism for navigating within an app.

NavigatorProvider

A NavigationProvider stores a set of Navigators that are valid ways to navigate to a destination.

NavigatorProviderKt
NavigatorState

The NavigatorState encapsulates the state shared between the Navigator and the NavController.

PopUpToBuilder

DSL for customizing NavOptionsBuilder.popUpTo operations.

ViewKt
NavDestination.Companion
Navigation

Entry point for navigation operations.