Namespace Unity.AppUI.Navigation

Classes

Argument

Argument stores information about a navigation argument.

Navigation actions provide a level of indirection between your navigation code and the underlying destinations. This allows you to define common actions that change their destination or NavOptions based on the current NavDestination.

The NavOptions associated with a NavAction are used by default when navigating to this action via Navigate(string, NavOptions, params Argument[]).

NavArgument

NavArgument stores information about a navigation argument.

NavArgumentKeyValuePair

NavArgumentKeyValuePair stores a key value pair of a navigation argument.

NavBackStackEntry

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

NavController

The NavController manages navigation within a NavHost. It is responsible for keeping track of the navigation stack and the current destination.

NavDestination

NavDestination represents one node within an overall navigation graph.

Destinations declare a set of actions that they support. These actions form a navigation API for the destination; the same actions declared on different destinations that fill similar roles allow application code to navigate based on semantic intent.

Each destination has a set of arguments that will be applied when navigating to that destination. Any default values for those arguments can be overridden at the time of navigation.

NavGraph

NavGraph is a collection of NavDestination nodes fetchable by ID.

A NavGraph serves as a 'virtual' destination: while the NavGraph itself will not appear on the back stack, navigating to the NavGraph will cause the startDestination to be added to the back stack.

NavGraphViewAsset

Representation of a navigation graph as a Unity asset. This asset contain a hierarchy of NavGraph instances.

NavGraphViewHierarchicalNode

Representation of a hierarchical node in a NavGraph.

NavGraphViewNode

Representation of a node in a NavGraph.

NavHost

The NavHost is the UI element that manages the navigation stack. It will manage the display of NavigationScreen objects through its NavController.

NavOptions

NavOptions stores special options for navigate actions

NavigationArgs

Argument to pass to a navigation request.

NavigationScreen

Base class for all navigation screens. A navigation screen is a VisualElement that can be pushed to a NavHost. Classes that inherit from this class can be used as template in a NavDestination with the value of typeof(YourScreenType).AssemblyQualifiedName.

VisualElementExtensions

Extension methods for VisualElement.

Interfaces

INavVisualController

Interface for a navigation visual controller. A navigation visual controller is responsible for setting up the visual elements of a navigation graph. This includes the bottom navigation bar, the app bar, the drawer and the navigation rail.