Styles and Unity style sheets
VisualElement includes style properties that set the dimensions of the element and how the element is drawn on screen, such as
Style properties are either set in C# or from a style sheet. Style properties are regrouped in their own data structure (
UIElements supports style sheets written in USS (Unity style sheet). USS files are text files inspired by Cascading Style Sheets (CSS) from HTML. The USS format is similar to CSS, but USS includes overrides and customizations to work better with Unity.
This section includes details on USS, its syntax, and its differences when compared to CSS.
Definition of a Unity style sheet
The fundamental building blocks of a Unity style sheet (USS) are as follows :
- A USS is a text file recognized as an assetAny media or data that can be used in your game or Project. An asset may come from a file created outside of Unity, such as a 3D model, an audio file or an image. You can also create some asset types in Unity, such as an Animator Controller, an Audio Mixer or a Render Texture. More info
See in Glossary. The text file must have the
- A USS only supports style rules.
- A style rule is composed of a selector and a declaration block.
- The selector identifies which visual element the style rule affects.
- The declaration block, enclosed by curly braces, contains one or more style declarations. Each style declaration is comprised of a property and a value. Each style declaration ends with a semi-colon.
- The value for each style property is a literal which, when parsed, must match the target property name.
The general syntax of a style rule is :
The USS syntax matches the W3C specifications for CSS3. UIElements uses the ExCSS open source parser to parse USS declarations. The ExCSS open source parser has its own test suite.
Attaching USS to visual elements
You can attach a Unity style sheet (USS) to any visual element. Style rules apply to the visual element and all of its descendants. Style sheets are also re-applied automatically when necessary.
AddStyleSheetPath() method to associate a USS to a visual element. You must also provide the
AddStyleSheetPath() method with the relative path to the enclosing folder. For Unity to recognize the USS file, it must be placed in the
Editor Default Resources folder, within the
If you modify a USS file while the
EditorWindow is running, style changes are applied immediately.
Style matching with rules
Once a style sheet is defined, it can be applied to a UIElements tree of visual elements.
During this process, selectors are matched against elements to resolve which properties are applied from the USS file. If a selector matches an element, the style declarations are applied to the element.
For example, the following rule matches any
You attach style sheets to a subtree with the
UIElements use the following criteria to match a visual element with its style rule:
- Its C# class name (always the most derived class)
name property that is a string
- A class list represented as a set of strings
- The ancestry and position of the VisualElement in the visual tree.
These traits can be used in selectors in the style sheet.
If you are familiar with CSS you can see the similarity with the HTML tag name, the
id attribute and
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?
Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.
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:
Thanks for helping to make the Unity documentation better!