Skip to content

UI.Window

Name Mandatory Description Default Type
⬅️ Input The value that will be passed to the Contents shards of the rendered window. Any
Output ➡️ The output of this shard will be its input. Any
Title No The window title displayed on the title bar. None String&StringNone
Contents No The UI contents. None NoneShard[Shard]
Position Yes Absolute position; or when anchor is set, relative offset. None Float2&Float2
Anchor Yes Corner or center of the screen. None Anchor
MinWidth No The minimum width of the window. None Float&FloatNone
MinHeight No The minimum height of the window. None Float&FloatNone
MaxWidth No The maximum width of the window. None Float&FloatNone
MaxHeight No The maximum height of the window. None Float&FloatNone
FixedWidth No The fixed size of the window. overrides all other min/max sizes. None Float&FloatNone
FixedHeight No The fixed size of the window. overrides all other min/max sizes. None Float&FloatNone
Closed No When provided with a callback, this window will have a close button and call this when pressed. None NoneShard[Shard]
Flags Yes Window flags. None WindowFlags[WindowFlags]
ID No An optional ID value to make the window unique if the title name collides. None String&StringNone
Transparency No If not None, it sets the window's transparency level based on the alpha value. false FloatNone

Creates a floating window which can be dragged, closed, collapsed, and resized.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
@wire(ui-wire {
  UI.Window(
    Title: "Greetings"
    Flags: WindowFlags::NoCollapse
    Contents: {
      "Hello shards!" | UI.Label
    }
  )
} Looped: true)

{ui-behavior: ui-wire}