USS built-in variables specify default values for Editor and runtime UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary. You can use these variables in your own USS to match your custom interfaces with Unity style.
The name of each built-in variable indicates how and where the variable is used. A variable name consists of one or more parts, separated by hyphens. Each part consists of one or more words separated by underscores.
--unity-{group}-{role_and_control}-{sub_element}-{pseudo_state_sequence}
Each part of the name shows the types of USS rules that use the variable.
For example, the following variable name:
--unity-colors-button-text-hover
Provides the following information about how Unity uses the variable:
Value | Meaning | |
---|---|---|
Group | colors |
Represents color data. |
Role/Control | button |
Affects buttons. |
Sub-Element | text |
Affects text. Its group is colors , so it affects text color. |
Pseudo-States | hover |
Applies to elements when the mouse pointer hovers over them. |
This USS built-in variable changes the color of button text when a user hovers over the button.
The group specifies what kind of data the variable represents. Each group has several possible sub-elements.
The variable names have the following groups:
Group | Used for |
---|---|
colors |
Color properties, such as background-color and border-color
|
metrics |
Properties that control dimensions and shapes. For example, border-radius , border-width , margin , and padding
|
icons |
Standard Unity icon images |
Roles and controls are two ways of grouping elements conceptually.
error
role includes all elements that display error messages to users.buttons
includes all buttons in the Editor.Each variable has either a role or a control.
The variable names have the following roles and controls:
Roles
Role | Description |
---|---|
default |
Default style settings such as text color, background, and margin. |
alternated_rows |
Elements that display tabular data with alternating row colors. For example, list items in a list view. |
error |
Elements that communicate error states to users. |
highlight |
Highlighted parts of the UI. For example, text selections, or selected items in tree views. |
link |
Parts of the UI (typically text) that are clickable links. This is the un-clicked state. |
play_mode |
Elements displayed when the Editor is in Play mode. |
visited_link |
Parts of the UI, typically text, that are clickable links that a user has already clicked. |
warning |
Elements that communicate a warning message to users. |
Controls
Control | Description |
---|---|
app_toolbar |
The main Unity toolbarA row of buttons and basic controls at the top of the Unity Editor that allows you to interact with the Editor in various ways (e.g. scaling, translation). More info See in Glossary |
app_toolbar_button |
Buttons in the main Unity toolbar |
box |
Boxes used to group elements in the Editor UI |
button |
Buttons in the UI, except for toolbars |
dropdown |
Dropdown lists or menus |
helpbox |
Boxes used to display help information |
input_field |
Fields used to input text or numeric values |
label |
Text labels in the Editor UI |
object_field |
Fields used for object values. For example, property values for a 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 or Asset. |
popup |
Popup menu and other popup controls |
preview |
Views used to display previews. For example, of Assets such as meshes and textures. |
scrollbar_groove |
The background element of a scrollbar in which users drag the scrollbar thumb |
scrollbar_thumb |
The draggable handle element in a scrollbar |
slider_groove |
The background element of a slider in which users drag the slider thumb |
slider_thumb |
The draggable handle element in a slider |
slider_thumb_halo |
An overlay displayed around the slider thumb when the user drags it |
tab |
Tab items in tab controls |
toolbar |
Any Editor toolbar except for the main Unity toolbar (app_toolbar ) |
toolbar_button |
Buttons in an Editor toolbar |
window |
Editor windows |
The sub-element is the part of an element that the variable affects. Together with a variable’s group
, the sub-element shows what kind of data the variable represents.
For example, when you see a variable name with the colors
group and the text
sub-element, it means Unity uses the variable in styles that affect text color.
The variable names have the following sub-elements:
Group | Sub-element | Description |
---|---|---|
colors |
||
background |
An element’s background color | |
border |
An element’s outer border color | |
border_accent |
An element’s inner border color. For example, 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 have a two-tone border |
|
text |
Text color for elements that display text | |
metrics |
||
margin_{left, top, right, bottom} |
An element’s margin values | |
padding_{left, top, right, bottom} |
An element’s padding values | |
border_{left, top, right, bottom}_width |
An element’s border width values | |
border_{left_top, left_bottom, right_top, right_bottom}_radius |
An element’s border radius values values | |
width, height |
An element’s width and height values |
The pseudo-state sequence is a list of UI states that Unity uses a variable for.
For example, when you see a variable name with the hover
pseudo state, it means Unity uses the variable in styles that affect elements when a user hovers the pointer over them.
For example: --unity-colors-toolbar_button-text-hover
.
A variable name can have more than one pseudo-state. Multiple pseudo states appear in alphabetical order, separated by underscores _
.
For example: --unity-colors-toolbar_button-text-focus_selected
.
Unity variable names can have any combination of the following pseudo-states:
Pseudo-state | Description |
---|---|
(none) | Normal state |
checked |
A checkbox-type control is checked |
disabled |
A control is disabled |
focus |
A control has focus |
hover |
A user hovers over a control |
inactive |
A control doesn’t have focus |
pressed |
A control is pressed |
selected |
A control is selected |
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.