ToolbarBreadcrumbs
Creates a breadcrumb UI element for the toolbar to help users navigate a hierarchy. For example, the visual scripting breadcrumb toolbar makes it easier to explore scripts because users can jump to any level of the script by clicking a breadcrumb item. For more information, refer to UXML element ToolbarBreadcrumbs.
Read time 9 minutesLast updated 16 hours ago
Definition
- Type: Class
- Namespace: UnityEditor.UIElements
- Assembly: UnityEditor.CoreModule
- Inherits from: VisualElement
- Implements: IEventHandler, IResolvedStyle, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, ICustomStyle
[UxmlElement][Icon("UIToolkit/Icons/ToolbarBreadcrumbs.png")]public class ToolbarBreadcrumbs : VisualElement, IEventHandler, IResolvedStyle, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, ICustomStyle
Remarks
Represents a breadcrumb trail to facilitate navigation between related items in a hierarchy.
Examples
using UnityEngine;using UnityEngine.UIElements;using UnityEditor.UIElements;public class CreateBreadcrumbsHelper{ ToolbarBreadcrumbs breadcrumbs; public void CreateBreadcrumbs(VisualElement root) { var toolbar = new Toolbar(); root.Add(toolbar); breadcrumbs = new ToolbarBreadcrumbs(); toolbar.Add(breadcrumbs); breadcrumbs.PushItem("myItemGrandParent", GoToRoot); breadcrumbs.PushItem("myItemParent", () => breadcrumbs.PopItem()); breadcrumbs.PushItem("myItem"); } void GoToRoot() { while (breadcrumbs.childCount > 1) breadcrumbs.PopItem(); }}
Static Fields
Value | Description |
|---|---|
| firstItemClassName | A Unity style sheet (USS) class for the first element or item in a breadcrumb toolbar. |
| itemClassName | A Unity style sheet (USS) class for individual items in a breadcrumb toolbar. |
| ussClassName | A Unity style sheet (USS) class for the main ToolbarBreadcrumbs container. |
Constructors
Constructor | Description |
|---|---|
| ToolbarBreadcrumbs() | Constructs a breadcrumb UI element for the toolbar to help users navigate a hierarchy. |
Methods
Method | Description |
|---|---|
| PopItem | Removes the last item in the breadcrumb toolbar, which is the deepest item in the hierarchy. |
| PushItem | Adds an item to the end of the breadcrumbs, which makes that item the deepest item in the hierarchy. |