Skip to content

Symbol

A Symbol is a static image component mainly used to add visual context and branding to an interface.

Component preview

Summary

Properties

View all inherited from BaseComponent

View all inherited from ImageLabel

Methods

View all inherited from ImageLabel

Events

View all inherited from ImageLabel

Types

type SymbolProperties = ImageLabel & {
    Style: ("Primary" | "Secondary")?,
}

type Symbol = BaseComponent & Components & SymbolProperties

Function Signature

function(self, properties: SymbolProperties): Symbol

Example

local symbol = row:Right():Symbol({
    Image = cascade.Symbols.sunMin,
})

print(symbol:IsA("ImageLabel")) --> true
print(symbol.ClassName) --> "ImageLabel"
print(symbol.Type) --> "Symbol"