Version: 2023.2+
Tabbed menus are widely used in video games and application UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary to organize and present content. Tab and TabView are powerful controls that simplify the process of creating tabbed menus.
This example demonstrates how to create tabbed menus in a sample sceneA Scene contains the environments and menus of your game. Think of each unique Scene file as a unique level. In each Scene, you place your environments, obstacles, and decorations, essentially designing and building your game in pieces. More info
See in Glossary and a custom Editor window. The menu has three tabs. Each tab presents certain content. When you select a tab, the content associated with that tab displays. The example also uses view data keys to preserve the tab orders for the Editor window.
You can find the completed files that this example creates in this GitHub repository.
This guide is for developers familiar with the Unity Editor, UI Toolkit, and C# scripting. Before you start, get familiar with the following:
Create a UI Document and add a TabView to it.
Create a project in Unity with any template.
In the Assets
folder, create a UI Document named TabbedMenu.uxml
.
Double-click TabbedMenu.uxml
to open it in the UI Builder.
Drag a TabView from the Library to the Hierarchy panel.
In the 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 of the TabView, do the following:
TabbedMenu
.Add three tabs to the TabView. For each tab, add a label as its child element which displays the tab content.
Under TabView, add three Tabs.
In the Inspector panel of each Tab, set Label to the following values:
London
for the first TabParis
for the second TabOttawa
for the third TabSet View Data Key to the following values:
LondonTab
for the first TabParisTab
for the second TabOttawaTab
for the third TabIn the Hierarchy panel, under each Tab, add a Label.
In the Inspector panel of each Label, Set Text to the following values:
London is the capital city of England
for the first LabelParis is the capital of France
for the second LabelOttawa is the capital of Canada
for the third LabelDefine the layout for tabs and tab content using USS. You can style the tabs and the tab content the way you like. This example adds a background color for the selected tab and hides the tab header underline.
In the Assets
folder, create a stylesheet named TabbedMenu.uss
.
Open TabbedMenu.uss
and add the following styling rules:
/* Style for tabs */ .unity-tab__header { background-color: rgb(229, 223, 223); -unity-font-style: bold; font-size: 14px; } /* Adds background color for the selected tab */ .unity-tab__header:checked { background-color: rgb(173, 166, 166); } /* Style for tabContent */ .tab-content { background-color: rgb(255, 255, 255); font-size: 20px; } /* By default, each tab header has an underline. This hides the header underline */ .unity-tab__header-underline { opacity: 0; /* or rgba(0, 0, 0, 0); */ }
Double-click TabbedMenu.uxml
to open it in UI Builder.
In the StyleSheets panel, select + > Add Existing USS.
Select the USS file that you created earlier.
Apply .tab-content
to each Label under Tab.
The finished TabbedMenu.uxml
looks like the following:
<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements" xsi="http://www.w3.org/2001/XMLSchema-instance" engine="UnityEngine.UIElements" editor="UnityEditor.UIElements" noNamespaceSchemaLocation="../../UIElementsSchema/UIElements.xsd" editor-extension-mode="False"> /* Your src might look different. If you save your UXML in UI Builder, USS file is referenced by the file location, fileID and guid. */ <Style src="TabbedMenu.uss" /> <ui:TabView reorderable="true" view-data-key="TabbedMenu"> <ui:Tab label="London" view-data-key="LondonTab"> <ui:Label text="London is the capital city of England" class="tab-content"/> </ui:Tab> <ui:Tab label="Paris" view-data-key="ParisTab"> <ui:Label text="Paris is the capital of France" class="tab-content"/> </ui:Tab> <ui:Tab label="Ottawa" view-data-key="OttawaTab"> <ui:Label text="Ottawa is the capital of Canada" class="tab-content"/> </ui:Tab> </ui:TabView> </ui:UXML>
Create a UIDocument GameObjectThe fundamental object in Unity scenes, which can represent characters, props, scenery, cameras, waypoints, and more. A GameObject’s functionality is defined by the Components attached to it. More info
See in Glossary in the SampleScene and add the UI Document as the source asset. Create a MonoBehaviour script that attaches the tabbed menu to the game.
In the SampleScene, select GameObject > UI Toolkit > UI Document.
In the Assets
folder, create a C# script namedTabbedMenu.cs
with the following content:
using UnityEngine; using UnityEngine.UIElements; //Inherits from class `MonoBehaviour`. This makes it attachable to a game object as a component. public class TabbedMenu : MonoBehaviour { private void OnEnable() { UIDocument menu = GetComponent<UIDocument>(); VisualElement root = menu.rootVisualElement; } }
Select UIDocument in the SampleScene.
In the Inspector window, select TabbedMenu.uxml from the Source Asset list.
Select TabbedMenu.cs
from the Add Component list.
Enter Play mode.
Select different tabs to see different contents.
Drag the tabs to reorder them.
Create a custom Editor window and add the tabbed menu to it. You can drag the tabs to reorder them. The tab orders are saved when you close and reopen the Editor window.
In the Assets
folder, create a folder named Editor
.
In the Editor
folder, create a C# script named TabbedMenuEditorWindow.cs
with the following content:
using UnityEditor; using UnityEngine; using UnityEngine.UIElements; public class TabbedMenuEditorWindow : EditorWindow { [MenuItem("Window/Tabbed Menu")] public static void ShowExample() { TabbedMenuEditorWindow wnd = GetWindow<TabbedMenuEditorWindow>(); wnd.titleContent = new GUIContent("Tabbed Menu"); } public void OnEnable() { VisualElement root = rootVisualElement; // Import UXML var visualTree = AssetDatabase.LoadAssetAtPath<VisualTreeAsset>("Assets/TabbedMenu.uxml"); VisualElement tabbedMenuUXML = visualTree.Instantiate(); root.Add(tabbedMenuUXML); } }
In the Editor, select Window > Tabbed Menu.
Select different tabs to see different contents.
Drag the tabs to reorder them.
Close the Editor window and reopen it. The tabs orders are saved.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.