UI Toolkit Debugger
The UI Toolkit Debugger is a tool that you can use to inspect and debug your UI elements in real-time. It provides a visual representation of your UI hierarchy. You use it to examine the state and properties of each UI element.
When you open the UI Toolkit Debugger, it displays a window that shows a live view of your UI hierarchy. You can select any element in the hierarchy to inspect its properties and state. The debugger also displays any errors or warnings related to your UI elements.
One of the key features of the UI Toolkit Debugger is the ability to view and edit the styles that are applied to your UI elements. This is done through the Style Inspector, which allows you to see all the style properties that are applied to a particular element. You can also edit these properties in real-time to see the effect they have on your UI.
Note: Editing styles in the Debugger only changes the inline styles on the live elements themselves and the changes aren’t saved anywhere and will be lost on the next UI regeneration.
To use the UI Toolkit Debugger:
Select Window > UI Toolkit > Debugger to open the UI Toolkit Debugger window.
-
Do the following:
- To debug elements in UI Builder, in the Viewport window of the UI Builder, click Preview to enable the Preview mode. Preview mode turns off the invisible elements in the Canvas. Those invisible elements absorb all mouse events and are used to pick elements for editing. UI Toolkit Debugger will pick them instead of your actual elements if they’re not turned off.
- To debug elements in the scene view, select the GameObject and enter Play mode.
In the UI Toolkit Debugger window, select Pick Element.
-
In the Canvas of the UI Builder or in the Game view, select the element that you want to debug. The UI Toolkit Debugger window shows a live view of your UI hierarchy and displays the following:
- All child elements of the
VisualElement - All USS selectors for each component of the
VisualElement - Detailed information for each USS selector
- All child elements of the
Tip: You can also open the UI Toolkit Debugger window by clicking ⋮ in the UI Builder or the Game view, and then selecting UI Toolkit Debugger.
