The UI Toolkit library of controls, components and other useful features for extending the UI Toolkit solution for Unity.
Note
The UIToolkitExtensions-1.0.0.unitypackage in the published release and the Unity Asset Store are marketed different to the OpenUPM release and are incompatible, so use one or the other. This is due to how Unity handles referencing for UIToolkit related sources.
We strongly recommend you use the OpenUPM release so as not to "dirty" your solution.
But if you wouldn't mind supporting the project, either through one of the Donation Options or purchasing the Unity asset, we would be eternally grateful.
You can follow the UI Toolkit Extensions team for updates and news on:
Ways to get in touch:
- Gitter Chat site for the UI / UI Toolkit Extensions project
- GitHub Discussions, if you have any questions, queries or suggestions
In this repository is a collection of extension scripts / effects and controls to enhance your Unity UI Toolkit experience. These scripts have been gathered from many sources, combined and improved over time.
If you wish to further support the Unity UI Toolkit Extensions project itself, then you can either subsidize your downloads above, or using the links below.
All funds go to support the project, no matter the amount. Donations in code are also extremely welcome
 |
 |
|---|---|
(PayPal account not required and you can remain anonymous if you wish)
- Install the package, see How do I get set up? below.
- Open the Package Manager window, select Unity UI Toolkit Extensions and import the UI Toolkit Extensions Samples from the Samples tab to get the example scenes.
- Browse the UI Toolkit Extensions documentation for control guides, API references and code examples.
The package ships 25 controls across navigation, layout, forms, media, toggles and feedback, plus reusable utilities, and 12 ready-to-run sample scenes. Everything lives in the Unity.UI.Extensions namespace.
Browse the full, searchable list with API references and code examples:
See the CHANGELOG for the complete control and example breakdown.
The recommended way to add the Unity UI Toolkit Extensions project to your solution is to use the Unity package Manager. Simply use the Unity Package Manager to reference the project to install it
The primary method for install is to use OpenUPM to add the package, it can be installed using the following OpenUPM CLI command:
openupm add com.unity.uitoolkitextensionsFor more details on using OpenUPM CLI, check the docs here.
Alternatively, you can also add the package manually through the Unity package manager using the scope com.unity.uitoolkitextensions, see the Unity Package Manager docs for more information.
Note
The package comes with some default svg assets for use in the controls and demonstration scenes which requires the com.unity.vectorgraphics installed to make use of them
Package Manager -> Install Package By Name -> com.unity.vectorgraphics
However, this is completely optional, but highly recommended when working with images with the UI Toolkit.
Got a script you want added? Then just fork the GitHub repository and submit a PR. All contributions accepted (including fixes)
Just ensure:
- The header of the script should match the standard used in all scripts.
- The script uses the Unity.UI.Extensions namespace so they do not affect any other developments.
- (optional) Add Component and Editor options where possible. (editor options are in the Editor\UIToolkitExtensionsMenuOptions.cs file)
All scripts conform to the MIT license and are free to use / distribute. See the LICENSE file for more information.
All these scripts were put together for my latest book Unity3D UI Essentials Check out the page on my blog for more details and learn all about the inner workings of the new Unity UI System.