Version: 2023.2+
Tabbed menus are widely used in video games and application UI 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 scene 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 Inspector 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:
[!code-css[(Modules/UIElements/Tests/UIElementsExamples/Assets/ui-toolkit-manual-code-examples/create-tabbed-menu/TabbedMenu.uss)]]
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:
[!code-xml[(Modules/UIElements/Tests/UIElementsExamples/Assets/ui-toolkit-manual-code-examples/create-tabbed-menu/TabbedMenu.uxml)]]
Create a UIDocument GameObject 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:
[!code-cs[(Modules/UIElements/Tests/UIElementsExamples/Assets/ui-toolkit-manual-code-examples/create-tabbed-menu/TabbedMenu.cs)]]
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:
[!code-cs[(Modules/UIElements/Tests/UIElementsExamples/Assets/ui-toolkit-manual-code-examples/create-tabbed-menu/Editor/TabbedMenuEditorWindow.cs)]]
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.