You can group multiple Tab elements within a TabView element to create a tab-based navigation system.
You can create a TabView with UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary Builder, UXML, or C#.
To create a TabView with C#, create a new instance of the TabView object and then add Tab elements to it. For example:
var tabView = new TabView("Title text");
var tab1 = new Tab("Tab 1");
var tab2 = new Tab("Tab 2");
var tab3 = new Tab("Tab 3");
tabView.Add(tab1);
tabView.Add(tab2);
tabView.Add(tab3);
To make tabs reorderable with a TabView, set the reorderable property to true.
To persist the tab order for a TabView in the Editor UI, assign a unique view-data-key to both the TabView and its contained Tab elements. The view-data-key stores the state of the tabs. If you left the view-data-key empty, the tab state doesn’t persist when the document is reloaded. for more information, refer to View data persistence.
For a TabView example, refer to Create a tabbed menu.
To see more TabView examples, in Unity, select Window > UI Toolkit > Samples > TabView.
C# class: TabView
Namespace: UnityEngine.UIElements
Base class: VisualElement
This element has the following member attributes:
| Name | Type | Description |
|---|---|---|
reorderable |
boolean |
A property that adds dragging support to tabs. The default value is false. Set this value to true to allow the user to reorder tabs in the tab view. |
This element inherits the following attributes from its base class:
| Name | Type | Description |
|---|---|---|
focusable |
boolean |
True if the element can be focused. |
tabindex |
int |
An integer used to sort focusables in the focus ring. Must be greater than or equal to zero. |
This element also inherits the following attributes from VisualElement:
| Name | Type | Description |
|---|---|---|
content-container |
string |
Child elements are added to it, usually this is the same as the element itself. |
data-source |
Object |
Assigns a data source to this VisualElement which overrides any inherited data source. This data source is inherited by all children. |
data-source-path |
string |
Path from the data source to the value. |
name |
string |
The name of this VisualElement. Use this property to write USS selectors that target a specific element. The standard practice is to give an element a unique name. |
picking-mode |
UIElements.PickingMode |
Determines if this element can be pick during mouseEvents or IPanel.Pick queries. |
style |
string |
Reference to the style object of this element. Contains data computed from USS files or inline styles written to this object in C#. |
tooltip |
string |
Text to display inside an information box after the user hovers the element for a small amount of time. This is only supported in the Editor UI. |
usage-hints |
UIElements.UsageHints |
A combination of hint values that specify high-level intended usage patterns for the VisualElement. This property can only be set when the VisualElement is not yet part of a Panel. Once part of a Panel, this property becomes effectively read-only, and attempts to change it will throw an exception. The specification of proper UsageHints drives the system to make better decisions on how to process or accelerate certain operations based on the anticipated usage pattern. Note that those hints do not affect behavioral or visual results, but only affect the overall performance of the panel and the elements within. It’s advised to always consider specifying the proper UsageHints, but keep in mind that some UsageHints might be internally ignored under certain conditions (e.g. due to hardware limitations on the target platform). |
view-data-key |
string |
Used for view data persistence (ie. tree expanded states, scroll position, zoom level). This is the key used to save/load the view data from the view data store. Not setting this key will disable persistence for this VisualElement. For further information on view data persistence, see the wiki:UIE-ViewData|Unity Manual. |
The following table lists all the C# public property names and their related USS selector.
| C# property | USS selector | Description |
|---|---|---|
ussClassName |
.unity-tab-view |
USS class name of elements of this type. |
contentContainerUssClassName |
.unity-tab-view__content-container |
USS class name for the content container of this type. |
reorderableUssClassName |
.unity-tab-view__reorderable |
The USS class name for reorderable tab view. |
verticalUssClassName |
.unity-tab-view__vertical |
The USS class name for vertical tab view. |
disabledUssClassName |
.unity-disabled |
USS class name of local disabled elements. |
You can also use the Matching Selectors section in the Inspector or the UI Toolkit Debugger to see which USS selectors affect the components of the VisualElement at every level of its hierarchy.