Skip to content

App

You can create a new app by calling the New method from the Cascade API. This returns a custom object merged with a ScreenGui.

The returned object exposes all built-in Components such as Window, Tab, and others for UI composition.

Summary

Properties

Property Type Description
WindowPill boolean? Whether or not the window minimize/restore pill should be visible.
Theme Theme? Light or Dark mode. See Themes
Accent Accent? Accent color palette. See Accents

View all inherited from ScreenGui

Methods

View all inherited from ScreenGui

Events

View all inherited from ScreenGui

Types

type AppProperties = ScreenGui & {
    WindowPill: boolean?,
    Theme: Theme?,
    Accent: Accent?,
}

type App = AppProperties & Components

Function Signature

function(self, properties: AppProperties): App

Example

local app = cascade.New({
    WindowPill = true,
    Theme = cascade.Themes.Light,
    Accent = cascade.Accents.Blue,
})