Window

Window is a high-level container that handles all base interaction with the user for you. Usually this is the first component called and most components stem from here.

Summary

Properties

Property	Type	Description
Searching	boolean?	Shows a text field in the title bar which can be used to search pages for content.
Draggable	boolean?	Enables window dragging via mouse or touch device.
Resizable	boolean?	Enables resizing via sides or corners.
Title	string?	Title displayed in the content titlebar.
Subtitle	string?	Subtitle displayed under the title. Will be visually disabled if not defined.
Maximized	boolean?	Should the window be maximized by default?
Minimized	boolean?	Should the window be minimized by default?
Dropshadow	boolean?	Enables a dropshadow effect on the window.
UIBlur	boolean?	Applies a background blur effect to the sidebar.

View all inherited from BaseComponent

View all inherited from Frame

Methods

View all inherited from Frame

Events

View all inherited from Frame

Types

type WindowProperties = Frame & {
    Searching: boolean?,
    Draggable: boolean?,
    Resizable: boolean?,
    Title: string?,
    Subtitle: string?,
    Maximized: boolean?,
    Minimized: boolean?,

    -- These effects can be system resource intensive.
    Dropshadow: boolean?,
    UIBlur: boolean?, -- Detectable in some games.
}

type Window = BaseComponent & Components & WindowProperties

Function Signature

function(self, properties: WindowProperties): Window

Example

local window = app:Window({
    Title = "Cascade",
    Subtitle = "This is my subtitle.",
})

print(window:IsA("Frame")) --> true
print(window.ClassName) --> "Frame"
print(window.Type) --> "Window"