Tab
UnityEngine.UIElements.Tab
읽는 시간 5분최근 업데이트: 한 달 전
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 property to . When a Tab is closable, a close icon appears on the Tab. If a user selects the close icon, the Tab closes.
closabletrueAdd 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 Texture, Sprite, or Vector. For information on how to reference an image asset, refer to Assets.
Do one of the following to add an icon to a Tab with UI Builder:
- From the Tab's Inspector 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 attribute:
icon-image<ui:Tab name="Tab" label="Tab text" icon-image="/path/to/image-file.png" />
To add an icon for a Tab with C#, assign the image source to the property:
iconImageTab myTab = new Tab("Tab text");var TabIconImage = Resources.Load<Texture2D>("image-file");myTab.iconImage = TabIconImage;
Examples
The following UXML example creates a TabView with Tabs:
<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements"> <TabView> <Tab label="UXML Tab A"> <Label text="UXML tab: This is some content for the first Tab." /> </Tab> <Tab label="UXML Tab B"> <Label text="UXML tab: This is some content for the second Tab." /> </Tab> </TabView></UXML>
The following USS example styles the TabView:
.some-styled-class .unity-tab__header { -unity-font-style: bold-and-italic;}.some-styled-class .unity-tab__header:checked > .unity-tab__header-underline { background-color: #46607C;}.some-styled-class .unity-tab__content-container { padding: 16px;}
The following C# example illustrates some of the customizable functionalities of the TabView and its Tabs:
// Create a TabView with Tabs that only contains a label. var csharpTabViewWithLabels = new TabView() { style = { marginTop = 15 } }; // marginTop not required, only for demonstration purposes. var tabOne = new Tab("One"); tabOne.Add(new Label("Tab with labels only: This is some content for the first Tab.") { style = { marginTop = 10 } }); csharpTabViewWithLabels.Add(tabOne); var tabTwo = new Tab("Two"); tabTwo.Add(new Label("Tab with labels only: This is some content for the second Tab.") { style = { marginTop = 10 } }); csharpTabViewWithLabels.Add(tabTwo); container.Add(csharpTabViewWithLabels); // Create a TabView with Tabs that only contains an icon. var csharpTabViewWithIcons = new TabView() { style = { marginTop = 15 } }; // marginTop not required, only for demonstration purposes. var tabIconConnect = new Tab(EditorGUIUtility.FindTexture("CloudConnect")); tabIconConnect.Add(new Label("Tab with icons only: This is some content for the first Tab.") { style = { marginTop = 10 } }); csharpTabViewWithIcons.Add(tabIconConnect); var tabIconStore = new Tab(EditorGUIUtility.FindTexture("Asset Store")); tabIconStore.Add(new Label("Tab with icons only: This is some content for the second Tab.") { style = { marginTop = 10 } }); csharpTabViewWithIcons.Add(tabIconStore); container.Add(csharpTabViewWithIcons); // Create a TabView with Tabs that only contains an icon and a label. var csharpTabViewWithIconsAndLabels = new TabView() { style = { marginTop = 15 } }; // marginTop not required, only for demonstration purposes. var tabConnect = new Tab("Connect", EditorGUIUtility.FindTexture("CloudConnect")); tabConnect.Add(new Label("Tab with an icon and a labels: This is some content for the first Tab.") { style = { marginTop = 10 } }); csharpTabViewWithIconsAndLabels.Add(tabConnect); var tabStore = new Tab("Store", EditorGUIUtility.FindTexture("Asset Store")); tabStore.Add(new Label("Tab with an icon and a labels: This is some content for the second Tab.") { style = { marginTop = 10 } }); csharpTabViewWithIconsAndLabels.Add(tabStore); container.Add(csharpTabViewWithIconsAndLabels); // Create a TabView that allows re-ordering of the tabs. var csharpReorderableTabView = new TabView() { reorderable = true, style = { marginTop = 10 } }; // marginTop not required, only for demonstration purposes. var tabA = new Tab("Tab A"); tabA.Add(new Label("Reorderable tabs: This is some content for Tab A") { style = { marginTop = 10 } }); csharpReorderableTabView.Add(tabA); var tabB = new Tab("Tab B"); tabB.Add(new Label("Reorderable tabs: This is some content for Tab B") { style = { marginTop = 10 } }); csharpReorderableTabView.Add(tabB); var tabC = new Tab("Tab C"); tabC.Add(new Label("Reorderable tabs: This is some content for Tab C") { style = { marginTop = 10 } }); csharpReorderableTabView.Add(tabC); container.Add(csharpReorderableTabView); // Create a TabView with closeable tabs. var closeTabInfoLabel = new Label($"Last tab closed: None"); void UpdateLabel(string newLabel) => closeTabInfoLabel.text = $"Last tab closed: {newLabel}"; var cSharpCloseableTabs = new TabView() { style = { marginTop = 10 } }; // marginTop not required, only for demonstration purposes. var closeableTabA = new Tab("Title A") { closeable = true }; closeableTabA.closed += (tab) => { UpdateLabel(tab.label); }; closeableTabA.Add(new Label("Closeable tabs: This is some content for Tab A") { style = { marginTop = 10 } }); cSharpCloseableTabs.Add(closeableTabA); var closeableTabB = new Tab("Title B") { closeable = true }; closeableTabB.closed += (tab) => { UpdateLabel(tab.label); }; closeableTabB.Add(new Label("Closeable tabs: This is some content for Tab B") { style = { marginTop = 10 } }); cSharpCloseableTabs.Add(closeableTabB); var closeableTabC = new Tab("Title C") { closeable = true }; closeableTabC.closed += (tab) => { UpdateLabel(tab.label); }; closeableTabC.Add(new Label("Closeable tabs: This is some content for Tab C") { style = { marginTop = 10 } }); cSharpCloseableTabs.Add(closeableTabC); container.Add(cSharpCloseableTabs); container.Add(closeTabInfoLabel); // Create a TabView and apply custom styling to specific areas of their tabs. var csharpCustomStyledTabView = new TabView() { style = { marginTop = 15 } }.WithClassList("some-styled-class"); // marginTop not required, only for demonstration purposes. var customStyledTabOne = new Tab("One"); customStyledTabOne.Add(new Label("Custom styled tabs: This is some content for the first Tab.")); csharpCustomStyledTabView.Add(customStyledTabOne); var customStyledTabTwo = new Tab("Two"); customStyledTabTwo.Add(new Label("Custom styled tabs: This is some content for the second Tab.")); csharpCustomStyledTabView.Add(customStyledTabTwo); container.Add(csharpCustomStyledTabView);
To try this example live in Unity, go to Window > UI Toolkit > Samples.
For more examples, refer to the following:
C# base class and namespace
C# class:
TabNamespace:
UnityEngine.UIElementsBase class:
VisualElementMember UXML attributes
This element has the following member attributes:
Name | Type | Description |
|---|---|---|
| | A property that adds the ability to close tabs. The default value is |
| | Sets the icon for the Tab's header. |
| | Sets the label of the Tab's header. |
Inherited UXML attributes
This element inherits the following attributes from its base class:
Name | Type | Description |
|---|---|---|
| | Whether an element can potentially receive focus. If false, the element can't receive focus. If true, the element receives focus only when its |
| | An integer used to sort focusable elements in the focus ring. Must be greater than or equal to zero. Setting the |
This element also inherits the following attributes from :
VisualElementName | Type | Description |
|---|---|---|
| | Logical container where child elements are added. If a child is added to this element, the child is added to this element's content container instead. When iterating over the If the content container is the same as the element itself, child elements are added directly to the element. This is true for most elements but can be overridden by more complex types. The |
| | Assigns a data source to this VisualElement which overrides any inherited data source. This data source is inherited by all children. |
| | Path from the data source to the value. |
| | The possible type of data source assignable to this VisualElement. This information is only used by the UI Builder as a hint to provide some completion to the data source path field when the effective data source cannot be specified at design time. |
| | Returns true if the This flag isn't changed if the VisualElement is disabled implicitly by one of its parents. To verify this, use |
| | Indicates the directionality of the element's text. The value will propagate to the element's children. |
| | 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. |
| | Determines if this element can be the target of pointer events or picked by Elements can not be picked if: - They are invisible- Their Elements with a picking mode of |
| | Sets the style values on a The returned style data, computed from USS files or inline styles written to this object in C#, doesn't represent the fully resolved styles, such as the final height and width of a VisualElement. To access these fully resolved styles, use For information about how to use this property and all the supported USS properties, refer to the Apply styles in C# scripts and USS properties reference manual pages. |
| | 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. |
| | A combination of hint values that specify high-level intended usage patterns for the |
| | Used for view data persistence, such as tree expanded states, scroll position, or zoom level. This key is used to save and load the view data from the view data store. If you don't set this key, the persistence is disabled for the associated |
USS classes
The following table lists all the C# public property names and their related USS selector.
C# property | USS selector | Description |
|---|---|---|
| | USS class name of elements of this type. |
| | USS class name for the header of this type. |
| | USS class name for the icon inside the header. |
| | USS class name for the icon inside the header when the value is null. |
| | USS class name for the icon inside the header when the label is empty or null. |
| | USS class name for the label of the header. |
| | USS class name for the label of the header when the value is empty or null. |
| | USS class name for the active state underline of the header. |
| | USS class name of container element of this type. |
| | USS class name for the dragging state of this type. |
| | USS class name for reorderable tab elements. |
| | USS class name for drag handle in reorderable tabs. |
| | USS class name for drag handlebar in reorderable tabs. |
| | The USS class name for a closeable tab. |
| | The USS class name for close button in closable tabs. |
| | 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 at every level of its hierarchy.
VisualElement