Class NavigationRail

A Navigation Rail is a UI element that provides a set of navigation options to the user on the side of the screen.

Inheritance
object
CallbackEventHandler
Focusable
VisualElement
BaseVisualElement
NavigationRail
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.UI
Assembly: Unity.AppUI.dll
Syntax
public class NavigationRail : BaseVisualElement, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, IContextOverrideElement, IAdditionalDataHolder

Constructors

NavigationRail()

Default constructor.

Declaration
public NavigationRail()

Fields

contentContainerUssClassName

The content container styling class.

Declaration
public const string contentContainerUssClassName = "appui-navigation-rail__content-container"
Field Value
Type Description
string

groupAlignmentUssClassName

The NavigationRail group alignment styling class.

Declaration
public const string groupAlignmentUssClassName = "appui-navigation-rail-group-align--"
Field Value
Type Description
string

labelTypeUssClassName

The NavigationRail label type styling class.

Declaration
public const string labelTypeUssClassName = "appui-navigation-rail-label-type--"
Field Value
Type Description
string

leadingContainerUssClassName

The leading container styling class.

Declaration
public const string leadingContainerUssClassName = "appui-navigation-rail__leading-container"
Field Value
Type Description
string

trailingContainerUssClassName

The trailing container styling class.

Declaration
public const string trailingContainerUssClassName = "appui-navigation-rail__trailing-container"
Field Value
Type Description
string

ussClassName

The NavigationRail main styling class.

Declaration
public const string ussClassName = "appui-navigation-rail"
Field Value
Type Description
string

variantUssClassName

The NavigationRail variant styling class.

Declaration
public const string variantUssClassName = "appui-navigation-rail--"
Field Value
Type Description
string

Properties

anchor

The anchor of the NavigationRail. The NavigationRail will be anchored to the left or right side of the screen.

Declaration
public NavigationRailAnchor anchor { get; set; }
Property Value
Type Description
NavigationRailAnchor

contentContainer

The content container of the NavigationRail.

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

groupAlignment

The alignment of the group of items.

Declaration
public GroupAlignment groupAlignment { get; set; }
Property Value
Type Description
GroupAlignment

labelType

The label type of the NavigationRail.

Declaration
public LabelType labelType { get; set; }
Property Value
Type Description
LabelType

leadingContainer

The leading container of the NavigationRail.

Declaration
public VisualElement leadingContainer { get; }
Property Value
Type Description
VisualElement

mainContainer

The main container of the NavigationRail.

Declaration
public VisualElement mainContainer { get; }
Property Value
Type Description
VisualElement

trailingContainer

The trailing container of the NavigationRail.

Declaration
public VisualElement trailingContainer { get; }
Property Value
Type Description
VisualElement

Methods

GetAnchorUssClassName(NavigationRailAnchor)

Declaration
public static string GetAnchorUssClassName(NavigationRailAnchor enumValue)
Parameters
Type Name Description
NavigationRailAnchor enumValue
Returns
Type Description
string

GetGroupAlignmentUssClassName(GroupAlignment)

Declaration
public static string GetGroupAlignmentUssClassName(GroupAlignment enumValue)
Parameters
Type Name Description
GroupAlignment enumValue
Returns
Type Description
string

GetLabelTypeUssClassName(LabelType)

Declaration
public static string GetLabelTypeUssClassName(LabelType enumValue)
Parameters
Type Name Description
LabelType enumValue
Returns
Type Description
string

Implements

Extension Methods