Want to learn how to create UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary with UI Builder? Use this example to get started.
To create UI in the UI Builder:
Before you start, get familiar with the following:
This example creates the main view for the Create a list view runtime UI example. It creates a root element as the background, with two containers. One container holds the character name list and another holds the character details. In the character details container, you add background and foreground frames. Finally, you add two labels for the character name. This example won’t create the character name list entry UI.
Create a new project and then create a root visual elementA node of a visual tree that instantiates or derives from the C# VisualElement
class. You can style the look, define the behaviour, and display it on screen as part of the UI. More info
See in Glossary that covers the entire screen. Set your root element to have a background color and center all child elements in the middle of the screen.
Create a project in Unity with any template.
Select Window > UI Toolkit > UI Builder.
In the UI Builder window, at the top left of the Viewport window, select File > New to create a new UXML document.
Name it as MainView.uxml
and save.
Drag VisualElement from Library into the Hierarchy panel.
Tip: You can also double-click a control to add it to the Hierarchy panel.
Select the element from the Hierarchy panel.
In the Inspector panel, make sure Flex > Grow is 1
. This sets the flex-grow
property to 1
, making it cover the entire screen.
To center all child elements, set both Align Items and Justify Content to Center
.
Set Background > Color to #732526
.
Note: By default, the Alpha value for colors is 0
, making them fully transparent. To make color opaque, set the Alpha value to 255
.
Create a new VisualElement underneath the root element. This element becomes the parent container for the left and right sections of the UI.
Drag VisualElement from Library to the root VisualElement in the Hierarchy panel.
Select the element from the Hierarchy panel.
In the Inspector panel, set Flex > Direction to row
.
Set Flex > Grow to 0
.
Set Size > Height to 350
pixels.
Add a ListView as the child element of the container to hold the character names.
Drag a ListView from the Library to the container VisualElement in the Hierarchy panel.
Select the element from the Hierarchy panel.
In the Inspector panel, set Name to CharacterList
.
Set Size > Width to 230
pixels.
Set Spacing > Margin > Right to 6
pixels.
Set Background > Color to #6E3925
.
Set Border > Color to #311A11
.
Set Border > Width to 4
pixels.
Set Border > Radius to 15
pixels.
Add a new VisualElement under the same parent as the #CharacterList
to hold the character details container. The purpose is that when the user selects a character from the list on the left, it displays the character’s portrait, name, and class.
Drag a VisualElement from the Library to the container element in the Hierarchy panel. This is the container to hold all the elements on the right.
Select the element from the Hierarchy panel.
In the Inspector panel, set Align > Align Items to flex-end
.
Set Align > Justify Content to space-between
.
Add another VisualElement as the child of the right container.
Select the element from the Hierarchy panel.
Set Flex > Grow to 0
.
Set Size > Width to 276
pixels.
In the Align section, set both Align Items and Justify Content to center
.
Set Spacing > Padding to 8
pixels.
Set Background > Color to #AA5939
.
The character details container will use the same border styles as the character names list container. Create a USS class to apply to both containers.
MainView.uss
and select Save..border
. A .border
selector appears in the StyleSheet panel..border
.#311A11
.4
pixels.15
pixels..border
from the StyleSheet panel to the character details container VisualElement..border
from the StyleSheet panel to #CharacterList.Your UI layout now looks like the following:
Add the individual UI controls to the character details container. The first step is to add the character portrait background.
Drag VisualElement from Library to the character details container.
Select the element from the Hierarchy panel.
In the Size section, set both Width and Height to 120
pixelsThe smallest unit in a computer image. Pixel size depends on your screen resolution. Pixel lighting is calculated at every screen pixel. More info
See in Glossary.
Set Spacing > Padding to 4
pixels.
Set Background > Color to #FF8554
.
Set Border > Color to #311A11
.
Set Border > Width to 2
pixels.
Set Border > Radius to 13
pixels.
Next in the character details container, add the foreground for an actual image.
Drag VisualElement from Library to the character details container.
Select the element from the Hierarchy panel.
Set Name to CharacterPortrait
.
Set Flex > Grow to 1
, so that the image can use all the available space.
Set Background > Scale Mode to scale-to-fit
, so that you can scale the image to match the element size while keeping the correct aspect ratio.
Add two label controls to the character details container to display the selected character’s name and class.
Drag Label from Library to the character details container in the Hierarchy panel.
Set Name
to CharacterName
.
Drag Label from Library to the character details container in the Hierarchy panel.
Set Name
to CharacterClass
.
Select the #CharacterName
element.
Set Text > Font Style to B
.
Set Text > Size to 18
pixels.
In the Viewport window, select File > Save to save the changes to MainView.uxml
.
In UI Builder, you can create elements and use inline styles only to experiment while the number of elements is still small. As you build a more complex UI, it’s easier to manage styles using style sheets. You can extract inline styles to a style sheet in UI Builder.
.background
as the class name..background
class selector with the inline styles you set for the root element and updates the UI Document (UXML) for the root visual element to use the class selector instead of the inline styles.If you want to continue to work on the Create a list view runtime UI example, you can repeat the steps to extract styles for all the other elements, and follow the instructions to create the example.
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.