Class Breadcrumbs

A navigation component that helps users track their location within an application's hierarchy.

Inheritance
object
CallbackEventHandler
Focusable
VisualElement
BaseVisualElement
Breadcrumbs
Implements
Inherited Members
VisualElement.Focus()
VisualElement.Overlaps(Rect)
VisualElement.ToString()
VisualElement.TryGetBinding(BindingId, out Binding)
VisualElement.TryGetDataSourceContext(BindingId, out DataSourceContext)
VisualElement.TryGetLastBindingToUIResult(in BindingId, out BindingResult)
VisualElement.TryGetLastBindingToSourceResult(in BindingId, out BindingResult)
VisualElement.GetFirstOfType<T>()
VisualElement.GetFirstAncestorOfType<T>()
VisualElement.canGrabFocus
VisualElement.focusController
VisualElement.cacheAsBitmap
CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.RegisterCallbackOnce<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
CallbackEventHandler.RegisterCallbackOnce<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, CallbackOptions)
CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, CallbackOptions)
CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, CallbackOptions)
CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, CallbackOptions)
CallbackEventHandler.NotifyPropertyChanged(in BindingId)
Namespace: Unity.AppUI.UI
Assembly: Unity.AppUI.dll
Syntax
[UxmlElement]
public class Breadcrumbs : BaseVisualElement, IEventHandler, IResolvedStyle, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IContextOverrideElement, IAdditionalDataHolder
Remarks

Breadcrumbs are a navigation pattern that shows users their current location in an application's hierarchy. They provide a trail of links that allows users to quickly move up to a parent level or previously viewed location.

The component consists of three main parts:

  • BreadcrumbItem: Clickable links representing each level in the hierarchy
  • BreadcrumbSeparator: Visual separator (default '/') between items
  • The current page/location is indicated by a BreadcrumbItem with isCurrent=true

Breadcrumbs are particularly useful in:

  • Applications with hierarchical navigation
  • Complex folder structures
  • Multi-step processes
  • Any interface where users need to understand and navigate their current location
Examples

Basic Breadcrumbs Implementation

A basic breadcrumbs navigation showing three levels deep with the current location.

<UXML xmlns:ui="Unity.AppUI.UI">
    <ui:Breadcrumbs>
        <ui:BreadcrumbItem text="Home" url="/" />
        <ui:BreadcrumbSeparator />
        <ui:BreadcrumbItem text="Projects" url="/projects" />
        <ui:BreadcrumbSeparator />
        <ui:BreadcrumbItem text="Project Alpha" is-current="true" />
    </ui:Breadcrumbs>
</UXML>

Creating Breadcrumbs in C#

Programmatically creating a breadcrumbs navigation with three levels.

var breadcrumbs = new Breadcrumbs();

var homeItem = new BreadcrumbItem { text = "Home", url = "/" };
var projectsItem = new BreadcrumbItem { text = "Projects", url = "/projects" };
var currentItem = new BreadcrumbItem { text = "Project Alpha", isCurrent = true };


breadcrumbs.Add(homeItem);
breadcrumbs.Add(new BreadcrumbSeparator());
breadcrumbs.Add(projectsItem);
breadcrumbs.Add(new BreadcrumbSeparator());
breadcrumbs.Add(currentItem);

Custom Separator

Using a custom separator character instead of the default '/'.

<UXML xmlns:ui="Unity.AppUI.UI">
    <ui:Breadcrumbs>
        <ui:BreadcrumbItem text="Home" />
        <ui:BreadcrumbSeparator text=">" />
        <ui:BreadcrumbItem text="Settings" is-current="true" />
    </ui:Breadcrumbs>
</UXML>

Constructors

Breadcrumbs()

Constructor.

Declaration
public Breadcrumbs()

Fields

ussClassName

The Breadcrumbs' USS class name.

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

Implements

Extension Methods