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`	`StringVar(String)None`
`Contents`	No	The UI contents.	`none`	`NoneShard[Shard]`
`Position`	No	Absolute position; or when anchor is set, relative offset.	`none`	`Float2Var(Float2)`
`Anchor`	No	Corner or center of the screen.	`none`	`Anchor`
`MinWidth`	No	The minimum width of the window.	`none`	`FloatVar(Float)None`
`MinHeight`	No	The minimum height of the window.	`none`	`FloatVar(Float)None`
`MaxWidth`	No	The maximum width of the window.	`none`	`FloatVar(Float)None`
`MaxHeight`	No	The maximum height of the window.	`none`	`FloatVar(Float)None`
`FixedWidth`	No	The fixed size of the window. overrides all other min/max sizes.	`none`	`FloatVar(Float)None`
`FixedHeight`	No	The fixed size of the window. overrides all other min/max sizes.	`none`	`FloatVar(Float)None`
`Closed`	No	When provided with a callback, this window will have a close button and call this when pressed.	`none`	`NoneShard[Shard]`
`Flags`	No	Window flags.	`none`	`WindowFlags[WindowFlags]`
`ID`	No	An optional ID value to make the window unique if the title name collides.	`none`	`StringVar(String)None`
`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¶

Code

@wire(ui-wire {
  UI.Window(
    Title: "Greetings"
    Flags: WindowFlags::NoCollapse
    Contents: {
      "Hello shards!" | UI.Label
    }
  )
} Looped: true)

{ui-behavior: ui-wire}