Version: 2020.2
UI Toolkit
The Visual Tree

The UI Toolkit Package

UI Toolkit is built into Unity as a core part of the Editor. It is also available as a package, called com.unity.ui(User Interface) Allows a user to interact with your application. More info
See in Glossary
, which is currently in preview. The built-in version for each major Unity release is based on a specific version of the package, but the two are not completely identical.

Built-in UI Toolkit vs. the UI Toolkit package

The built-in version of UI Toolkit includes the features required to make user interfaces for the Unity Editor. The package version contains the exact same features, as well as the features required to make runtime user interfaces for games and applications.

Both versions of UI Toolkit work exactly the same way, and use the same namespaces: UnityEditor.UIElements and UnityEngine.UIElements. If you install the package, you will not see any difference other than having access to the additional runtime features. You do not need to do any additional configuration.

Choosing a version of UI Toolkit

Whether you use the built-in version of UI Toolkit or the package depends on what type of user interfaces you plan to make.

  • To create Editor-only user interfaces, use the built-in version of UI Toolkit that ships with Unity.
  • To create runtime user interfaces for games and applications, or a mix of runtime and Editor interfaces, install the UI Toolkit package.

You may also want to install the package if you want early access to the very latest UI Toolkit features. Unity may release preview versions of the com.unity.ui package between major Unity releases.

NOTE:
Preview versions of com.unity.ui might contain features that are not stable or final. Avoid using preview versions in production.

Installing the UI Toolkit package

You install the UI Toolkit package from the package manager:

  1. Click Add (+)
  2. From the menu, choose Add package from git URL…. A text field appears.
  3. In the text field, type com.unity.ui
  4. Click Add.

The package manager automatically finds and installs the UI Toolkit package.

UI Toolkit
The Visual Tree