Class NavigationScreen

Base class for all navigation screens that implements the INavigationScreen interface. A navigation screen is a VisualElement that can be pushed to a NavHost.

Inheritance
object
CallbackEventHandler
Focusable
VisualElement
NavigationScreen
Implements
Inherited Members
VisualElement.ExecuteDefaultAction(EventBase)
VisualElement.Focus()
VisualElement.Overlaps(Rect)
VisualElement.ToString()
VisualElement.GetFirstOfType<T>()
VisualElement.GetFirstAncestorOfType<T>()
VisualElement.canGrabFocus
VisualElement.focusController
VisualElement.cacheAsBitmap
CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TrickleDown)
Namespace: Unity.AppUI.Navigation
Assembly: Unity.AppUI.Navigation.dll
Syntax
public class NavigationScreen : VisualElement, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, INavigationScreen

Constructors

NavigationScreen()

Base Constructor.

Declaration
public NavigationScreen()
See Also

Fields

appBarUssClassName

The NavigationScreen app bar styling class.

Declaration
public const string appBarUssClassName = "appui-navigation-screen__app-bar"
Field Value
Type Description
string
See Also

bottomNavBarUssClassName

The NavigationScreen bottom nav bar styling class.

Declaration
public const string bottomNavBarUssClassName = "appui-navigation-screen__bottom-nav-bar"
Field Value
Type Description
string
See Also

containerUssClassName

The NavigationScreen container styling class.

Declaration
public const string containerUssClassName = "appui-navigation-screen__container"
Field Value
Type Description
string
See Also

drawerUssClassName

The NavigationScreen drawer styling class.

Declaration
public const string drawerUssClassName = "appui-navigation-screen__drawer"
Field Value
Type Description
string
See Also

leftContainerUssClassName

The NavigationScreen left container styling class.

Declaration
public const string leftContainerUssClassName = "appui-navigation-screen__left-container"
Field Value
Type Description
string
See Also

navigationRailUssClassName

The NavigationScreen navigation rail styling class.

Declaration
public const string navigationRailUssClassName = "appui-navigation-screen__navigation-rail"
Field Value
Type Description
string
See Also

rightContainerUssClassName

The NavigationScreen right container styling class.

Declaration
public const string rightContainerUssClassName = "appui-navigation-screen__right-container"
Field Value
Type Description
string
See Also

ussClassName

The NavigationScreen main styling class.

Declaration
public const string ussClassName = "appui-navigation-screen"
Field Value
Type Description
string
See Also

withAppBarUssClassName

The NavigationScreen with app bar styling class.

Declaration
public const string withAppBarUssClassName = "appui-navigation-screen--with-appbar"
Field Value
Type Description
string
See Also

withBottomNavBarUssClassName

The NavigationScreen with bottom nav bar styling class.

Declaration
public const string withBottomNavBarUssClassName = "appui-navigation-screen--with-bottom-nav-bar"
Field Value
Type Description
string
See Also

withCompactAppBarUssClassName

The NavigationScreen with compact app bar styling class.

Declaration
public const string withCompactAppBarUssClassName = "appui-navigation-screen--with-appbar--compact"
Field Value
Type Description
string
See Also

withDrawerUssClassName

The NavigationScreen with drawer styling class.

Declaration
public const string withDrawerUssClassName = "appui-navigation-screen--with-drawer--"
Field Value
Type Description
string
See Also

withRailUssClassName

The NavigationScreen with rail styling class.

Declaration
public const string withRailUssClassName = "appui-navigation-screen--with-rail--"
Field Value
Type Description
string
See Also

Properties

appBar

The AppBar that will be used to display the app bar of the screen.

Declaration
public AppBar appBar { get; }
Property Value
Type Description
AppBar
See Also

bottomNavBar

The BottomNavBar that will be used to display the bottom navigation items of the screen.

Declaration
public BottomNavBar bottomNavBar { get; }
Property Value
Type Description
BottomNavBar
See Also

contentContainer

Child elements are added to this element.

Declaration
public override VisualElement contentContainer { get; }
Property Value
Type Description
VisualElement
Overrides
See Also

drawer

The Drawer that will be used to display the drawer of the screen.

Declaration
public Drawer drawer { get; }
Property Value
Type Description
Drawer
See Also

navigationRail

The NavigationRail that will be used to display the navigation items of the screen.

Declaration
public NavigationRail navigationRail { get; }
Property Value
Type Description
NavigationRail
See Also

scrollView

The ScrollView that will be used to display the content of the screen.

Declaration
public ScrollView scrollView { get; }
Property Value
Type Description
ScrollView
See Also

showAppBar

Display the bottom navigation bar on this screen.

Declaration
public bool showAppBar { get; set; }
Property Value
Type Description
bool
See Also

showBackButton

Display the drawer on this screen.

Declaration
public bool showBackButton { get; set; }
Property Value
Type Description
bool
See Also

showBottomNavBar

Display the navigation rail on this screen.

Declaration
public bool showBottomNavBar { get; set; }
Property Value
Type Description
bool
See Also

showDrawer

Display the drawer on this screen.

Declaration
public bool showDrawer { get; set; }
Property Value
Type Description
bool
See Also

showNavigationRail

Display the navigation rail on this screen.

Declaration
public bool showNavigationRail { get; set; }
Property Value
Type Description
bool
See Also

Methods

OnEnter(NavController, NavDestination, Argument[])

Called when the screen is pushed to a NavHost.

Declaration
public virtual void OnEnter(NavController controller, NavDestination destination, Argument[] args)
Parameters
Type Name Description
NavController controller

The NavController that manages the navigation stack.
NavDestination destination

The NavDestination associated with this screen.
Argument[] args

The arguments associated with this screen.
See Also

OnExit(NavController, NavDestination, Argument[])

Called when the screen is popped from a NavHost.

Declaration
public virtual void OnExit(NavController controller, NavDestination destination, Argument[] args)
Parameters
Type Name Description
NavController controller

The NavController that manages the navigation stack.
NavDestination destination

The NavDestination associated with this screen.
Argument[] args

The arguments associated with this screen.
Remarks

This method is called before the screen is removed from the NavHost.

See Also

SetupAppBar(AppBar, NavController)

Implement this method to setup the AppBar of this screen specifically.

Declaration
protected virtual void SetupAppBar(AppBar appBar, NavController controller)
Parameters
Type Name Description
AppBar appBar

The AppBar to setup.
NavController controller

The NavController that manages the navigation stack.
Remarks

To setup the AppBar globally, use SetupAppBar(AppBar, NavDestination, NavController) in your implementation of INavVisualController.

See Also

SetupBottomNavBar(BottomNavBar, NavController)

Implement this method to setup the BottomNavBar of this screen specifically.

Declaration
protected virtual void SetupBottomNavBar(BottomNavBar bottomNavBar, NavController controller)
Parameters
Type Name Description
BottomNavBar bottomNavBar

The BottomNavBar to setup.
NavController controller

The NavController that manages the navigation stack.
Remarks

To setup the BottomNavBar globally, use SetupBottomNavBar(BottomNavBar, NavDestination, NavController) in your implementation of INavVisualController.

See Also

SetupDrawer(Drawer, NavController)

Implement this method to setup the Drawer of this screen specifically.

Declaration
protected virtual void SetupDrawer(Drawer drawer, NavController controller)
Parameters
Type Name Description
Drawer drawer

The Drawer to setup.
NavController controller

The NavController that manages the navigation stack.
Remarks

To setup the Drawer globally, use SetupDrawer(Drawer, NavDestination, NavController) in your implementation of INavVisualController.

See Also

SetupNavigationRail(NavigationRail, NavController)

Implement this method to setup the NavigationRail of this screen specifically.

Declaration
protected virtual void SetupNavigationRail(NavigationRail navigationRail, NavController controller)
Parameters
Type Name Description
NavigationRail navigationRail

The NavigationRail to setup.
NavController controller

The NavController that manages the navigation stack.
Remarks

To setup the NavigationRail globally, use SetupNavigationRail(NavigationRail, NavDestination, NavController) in your implementation of INavVisualController.

See Also

Implements

Extension Methods

See Also