Technical users can define the layout of the UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary directly in C# scriptsA piece of code that allows you to create your own Components, trigger game events, modify Component properties over time and respond to user input in any way you like. More info
See in Glossary.
You can define the look of controls in a USS file, or modify the style properties of the control in your C# script.
Controls are interactive and represent a value that you can change. For example, a FloatField
represents a float value. You can create C# scripts to change the value of a control, register a callback, or apply data binding.
To use a control in a UI, add it to the visual treeAn object graph, made of lightweight nodes, that holds all the elements in a window or panel. It defines every UI you build with the UI Toolkit.
See in Glossary.
The following example adds a Button control to an existing visual tree.
var newButton = new Button("Click me!"); rootVisualElement.Add(newButton);
When adding controls to a UI hierarchy, the layout engine automatically handles the sizing and positioning. You can also override the size and position of visual elements.
To access or change the value of a control, use its value
property.
The following example creates a Toggle control and a Button control. When you click the button, the value of the toggle flips.
// Create a toggle and register callback m_MyToggle = new Toggle("Test Toggle") { name = "My Toggle" }; rootVisualElement.Add(m_MyToggle); // Create button to flip the toggle's value Button button01 = new Button() { text = "Toggle" }; button01.clicked += () => { m_MyToggle.value = !m_MyToggle.value; }; rootVisualElement.Add(button01);
For more information about the properties of a specific control, see UI Toolkit built-in controls reference.
Controls that have value
properties send an event if the value changes. You can register a callback to receive this event.
The following example creates a Toggle control and registers a callback:
// Create a toggle and register callback m_MyToggle = new Toggle("Test Toggle") { name = "My Toggle" }; m_MyToggle.RegisterValueChangedCallback((evt) => { Debug.Log("Change Event received"); }); rootVisualElement.Add(m_MyToggle);
To learn more about callbacks and events, see Events Handling.
You can bind controls to an object or a serialized property. For example, you can bind a FloatField control to a public float variable that belongs to a MonoBehaviour
. When the control binds to the property, it automatically displays the value of the property. When you modify the control, the value of the property updates.
Similarly, when the property value changes through code, the UI displays the updated value. This two-way connection is useful when you create custom 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 windows.
For more information about data binding, see SerializedObject data binding.
Not all controls are bindable. For a list of built-in controls and whether they support binding, see UI Toolkit built-in controls reference.
Some controls have read-only child elements. For example, a ListView
control has a ScrollView
child. You can use UQuery to access the child’s properties and override their values.
The following example changes the scroll speed of a ListView
control by overriding the mouseWheelScrollSize
property of the ScrollView
child:
var scrollView = listView.Q<ScrollView>(); scrollView.mouseWheelScrollSize = 55;
Controls have different states that you can manage in your C# scripts. For example, you can enable or disable a control.
The following example creates a Toggle control and a Button control. When you click the button, the toggle is disabled.
// Create a toggle. Toggle myToggle = new Toggle("A Toggle"); // Create a button to disable the toggle. Button button01 = new Button(); button01.text = "Button01"; button01.RegisterCallback<ClickEvent>(evt => { myToggle.SetEnabled(false); });
You can also implement a visual feedback change when the state changes in USS using the pseudo-classes. For example, to disable a toggle, use a selector that has the disabled
pseudo state:
.unity-button:disabled { background-color: #000000; }
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.