#Create windows

There are three ways to create a window. All three end in Workspace.RegisterWindow.

Video tutorial: Windows. All videos: Video tutorials.

A registered window is closed until something opens it. Window ids must be unique in a workspace.

#UXML: Window

Put Window elements inside an Workspace. The children of Window become the window content. On attach, the element registers the window and removes itself from the tree. It opens the window if the initial state is not closed.

In UI Builder, the element does not register. It draws the window with its title bar and its content at its initial position and size, so you can drop controls into it on the canvas.

<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:tb="UIToolbox">
  <tb:Workspace name="workspace" theme-name="dark" style="flex-grow: 1;">
    <tb:Window id="Inventory" title="Inventory" width="400" height="300" initial-window-state="open">
      <ui:Label text="Items go here." />
    </tb:Window>
  </tb:Workspace>
</ui:UXML>

Window attributes:

Workspace attributes:

#Code: the builder

WindowDescriptor.Builder() returns a WindowDescriptor.WindowDescriptorBuilder.

Important:

• RegisterWindow gives a window without a host a WorkspaceHost for that workspace.
• RegisterWindow does not open the window, even when InitialState is Open. Pass openImmediately: true, or call OpenWindowAsync.
• A window resizes by pointer only through resize handles. A minimized window cannot be resized, and its handles are hidden.

using UIToolbox;
using UnityEngine;
using UnityEngine.UIElements;

public class InventoryWindow : MonoBehaviour
{
    private void Start()
    {
        var workspace = GetComponent<UIDocument>().rootVisualElement.Q<Workspace>();

        var content = new VisualElement();
        content.Add(new Label("Items go here."));

        var window = WindowDescriptor.Builder()
            .WithId("Inventory")
            .WithTitle("Inventory")
            .WithSize(400, 300)
            .WithContent(content)
            .Build();

        window.Closing += args =>
        {
            if (HasUnsavedChanges()) args.Cancel = true;
        };

        workspace.RegisterWindow(window, openImmediately: true);
    }

    private static bool HasUnsavedChanges() => false;
}