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

IEventHandler

IVisualElementScheduler

IExperimentalFeatures

ITransitionAnimations

ITransform

IResolvedStyle

IContextOverrideElement

IAdditionalDataHolder

Inherited Members

BaseVisualElement.contextPrefix

BaseVisualElement.scaleOverride

BaseVisualElement.themeOverride

BaseVisualElement.langOverride

BaseVisualElement.layoutDirectionOverride

BaseVisualElement.preferredTooltipPlacementOverride

BaseVisualElement.tooltipDelayMsOverride

BaseVisualElement.GetLayoutDirectionUssClassName(Dir)

VisualElement.disabledUssClassName

VisualElement.ExecuteDefaultAction(EventBase)

VisualElement.Focus()

VisualElement.SendEvent(EventBase)

VisualElement.SetEnabledFromHierarchy(bool)

VisualElement.SetEnabled(bool)

VisualElement.MarkDirtyRepaint()

VisualElement.ContainsPoint(Vector2)

VisualElement.Overlaps(Rect)

VisualElement.DoMeasure(float, VisualElement.MeasureMode, float, VisualElement.MeasureMode)

VisualElement.ToString()

VisualElement.GetClasses()

VisualElement.ClearClassList()

VisualElement.AddToClassList(string)

VisualElement.RemoveFromClassList(string)

VisualElement.ToggleInClassList(string)

VisualElement.EnableInClassList(string, bool)

VisualElement.ClassListContains(string)

VisualElement.FindAncestorUserData()

VisualElement.Add(VisualElement)

VisualElement.Insert(int, VisualElement)

VisualElement.Remove(VisualElement)

VisualElement.RemoveAt(int)

VisualElement.Clear()

VisualElement.ElementAt(int)

VisualElement.IndexOf(VisualElement)

VisualElement.Children()

VisualElement.Sort(Comparison<VisualElement>)

VisualElement.BringToFront()

VisualElement.SendToBack()

VisualElement.PlaceBehind(VisualElement)

VisualElement.PlaceInFront(VisualElement)

VisualElement.RemoveFromHierarchy()

VisualElement.GetFirstOfType<T>()

VisualElement.GetFirstAncestorOfType<T>()

VisualElement.Contains(VisualElement)

VisualElement.FindCommonAncestor(VisualElement)

VisualElement.style

VisualElement.customStyle

VisualElement.styleSheets

VisualElement.schedule

VisualElement.tooltip

VisualElement.experimental

VisualElement.viewDataKey

VisualElement.userData

VisualElement.canGrabFocus

VisualElement.focusController

VisualElement.usageHints

VisualElement.transform

VisualElement.layout

VisualElement.contentRect

VisualElement.paddingRect

VisualElement.worldBound

VisualElement.localBound

VisualElement.worldTransform

VisualElement.pickingMode

VisualElement.name

VisualElement.enabledInHierarchy

VisualElement.enabledSelf

VisualElement.visible

VisualElement.generateVisualContent

VisualElement.hierarchy

VisualElement.cacheAsBitmap

VisualElement.parent

VisualElement.panel

VisualElement.visualTreeAssetSource

VisualElement.this[int]

VisualElement.childCount

VisualElement.resolvedStyle

Focusable.Blur()

Focusable.focusable

Focusable.tabIndex

Focusable.delegatesFocus

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)

CallbackEventHandler.HandleEvent(EventBase)

CallbackEventHandler.HasTrickleDownHandlers()

CallbackEventHandler.HasBubbleUpHandlers()

CallbackEventHandler.ExecuteDefaultActionAtTarget(EventBase)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Unity.AppUI.UI

Assembly: Unity.AppUI.dll

Syntax

public class NavigationRail : BaseVisualElement, IEventHandler, IVisualElementScheduler, IExperimentalFeatures, ITransitionAnimations, ITransform, 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

VisualElement.contentContainer

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

IEventHandler

IVisualElementScheduler

IExperimentalFeatures

ITransitionAnimations

ITransform

IResolvedStyle

IContextOverrideElement

IAdditionalDataHolder

Extension Methods

VisualElementExtensions.FindNavController(VisualElement)

RegisterUpdateCallbackExtensions.RegisterUpdateCallback(VisualElement, EventCallback<UpdateEvent>)

RegisterUpdateCallbackExtensions.UnregisterUpdateCallback(VisualElement, EventCallback<UpdateEvent>)

VisualElementExtensions.EnableDynamicTransform(VisualElement, bool)

VisualElementExtensions.EnablePicking(VisualElement, bool)

VisualElementExtensions.GetChildren<T>(VisualElement, bool)

VisualElementExtensions.GetContextProvider<T>(VisualElement)

VisualElementExtensions.GetContextProvider<T>(VisualElement, string)

VisualElementExtensions.GetContext<T>(VisualElement)

VisualElementExtensions.GetContext<T>(VisualElement, string)

VisualElementExtensions.GetExclusiveRootElement(VisualElement)

VisualElementExtensions.GetLastAncestorOfType<T>(VisualElement)

VisualElementExtensions.GetPreferredTooltipPlacement(VisualElement)

VisualElementExtensions.GetSelfContext<T>(VisualElement)

VisualElementExtensions.GetSelfContext<T>(VisualElement, string)

VisualElementExtensions.GetTooltipContent(VisualElement)

VisualElementExtensions.GetTooltipTemplate(VisualElement)

VisualElementExtensions.HasAncestorsOfType<T>(VisualElement)

VisualElementExtensions.IsContextProvider<T>(VisualElement)

VisualElementExtensions.IsContextProvider<T>(VisualElement, string)

VisualElementExtensions.IsInvisible(VisualElement)

VisualElementExtensions.IsOnScreen(VisualElement)

VisualElementExtensions.ProvideContext<T>(VisualElement, string, T)

VisualElementExtensions.ProvideContext<T>(VisualElement, T)

VisualElementExtensions.RegisterContextChangedCallback<T>(VisualElement, string, EventCallback<ContextChangedEvent<T>>)

VisualElementExtensions.RegisterContextChangedCallback<T>(VisualElement, EventCallback<ContextChangedEvent<T>>)

VisualElementExtensions.SetPreferredTooltipPlacement(VisualElement, OptionalEnum<PopoverPlacement>)

VisualElementExtensions.SetTooltipContent(VisualElement, VisualElementExtensions.TooltipContentCallback)

VisualElementExtensions.SetTooltipTemplate(VisualElement, VisualElement)

VisualElementExtensions.UnregisterContextChangedCallback<T>(VisualElement, string, EventCallback<ContextChangedEvent<T>>)

VisualElementExtensions.UnregisterContextChangedCallback<T>(VisualElement, EventCallback<ContextChangedEvent<T>>)