UXML element Tab

A Tab element represents a single tab within a TabView. In a window or menu, you can use a tab to group related content.

Make a Tab closable

To make it so a Tab can be closed, set the closable property to true. When a Tab is closable, a close icon appears on the Tab. If a user selects the close icon, the Tab closes.

Add an icon to a Tab

You can add an icon to your Tab to make it more visually appealing. Icons can be image assets that exist in your project such as a Texture, Render TextureA special type of Texture that is created and updated at runtime. To use them, first create a new Render Texture and designate one of your Cameras to render into it. Then you can use the Render Texture in a Material just like a regular Texture. More info
See in Glossary, SpriteA 2D graphic objects. If you are used to working in 3D, Sprites are essentially just standard textures but there are special techniques for combining and managing sprite textures for efficiency and convenience during development. More info
See in Glossary, or Vector. For information on how to reference an image asset, refer to AssetsAny media or data that can be used in your game or project. An asset may come from a file created outside of Unity, such as a 3D Model, an audio file or an image. You can also create some asset types in Unity, such as an Animator Controller, an Audio Mixer or a Render Texture. More info
See in Glossary.

Do one of the following to add an icon to a Tab with UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary Builder:

From the Tab’s InspectorA Unity window that displays information about the currently selected GameObject, asset or project settings, allowing you to inspect and edit the values. More info
See in Glossary panel, select an icon from the Icon Image dropdown list.
Drag an icon from the Assets window to the Icon Image field located in the Tab’s Inspector panel.

To add an icon for a Tab with UXML, add the source of the image to the icon-image attribute:

<ui:Tab name="Tab" text="Tab text" icon-image="/path/to/image-file.png" />

To add an icon for a Tab with C#, assign the image source to the iconImage property:

Tab myTab = new Tab();
var TabIconImage = Resources.Load<Texture2D>("image-file");

myTab.text = "Tab text";
myTab.iconImage = TabIconImage;

Examples

For a Tab example, refer to Create a tabbed menu.

To see more Tab examples, in Unity, select Window > UI Toolkit > Samples > TabView.

C# base class and namespace

C# class: Tab
Namespace: UnityEngine.UIElements
Base class: VisualElement

Member UXML attributes

This element has the following member attributes:

Name	Type	Description
`closeable`	`boolean`	A property that adds the ability to close tabs. The default value is `false`. Set this value to `true` to allow the user to close tabs in the tab view.
`icon-image`	`Object`	Sets the icon for the Tab’s header.
`label`	`string`	Sets the label of the Tab’s header.

Inherited UXML attributes

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`.

USS classes

The following table lists all the C# public property names and their related USS selector.

C# property	USS selector	Description
`ussClassName`	`.unity-tab`	USS class name of elements of this type.
`tabHeaderUssClassName`	`.unity-tab__header`	USS class name for the header of this type.
`tabHeaderImageUssClassName`	`.unity-tab__header-image`	USS class name for the icon inside the header.
`tabHeaderEmptyImageUssClassName`	`.unity-tab__header-image--empty`	USS class name for the icon inside the header when the value is null.
`tabHeaderStandaloneImageUssClassName`	`.unity-tab__header-image--standalone`	USS class name for the icon inside the header when the label is empty or null.
`tabHeaderLabelUssClassName`	`.unity-tab__header-label`	USS class name for the label of the header.
`tabHeaderEmptyLabeUssClassName`	`.unity-tab__header-label--empty`	USS class name for the label of the header when the value is empty or null.
`tabHeaderUnderlineUssClassName`	`.unity-tab__header-underline`	USS class name for the active state underline of the header.
`contentUssClassName`	`.unity-tab__content-container`	USS class name of container element of this type.
`draggingUssClassName`	`.unity-tab--dragging`	USS class name for the dragging state of this type.
`reorderableUssClassName`	`.unity-tab__reorderable`	USS class name for reorderable tab elements.
`reorderableItemHandleUssClassName`	`.unity-tab__reorderable-handle`	USS class name for drag handle in reorderable tabs.
`reorderableItemHandleBarUssClassName`	`.unity-tab__reorderable-handle-bar`	USS class name for drag handlebar in reorderable tabs.
`closeableUssClassName`	`.unity-tab__header__closeable`	The USS class name for a closeable tab.
`closeButtonUssClassName`	`.unity-tab__close-button`	The USS class name for close button in closable tabs.
`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.

Additional resources

UXML element TabView

UXML element SliderInt

UXML element TabView

"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。

公安部备案号:

31010902002961

法律条款隐私政策 Cookies