Skip to content

ImageSurface

An ImageSurface displays an image on top of a colored surface.

Component preview

Summary

Properties

Property Type Description
Image string? The 20 x 20 image asset ID displayed on the surface. You can use cascade.Symbols
ImageColor Color3? The tint color applied to the image. Defaults to Color3.fromRGB(255, 255, 255).
SurfaceColor Color3? The background color of the surface. Defaults to Color3.fromRGB(200, 200, 200).
Gradient boolean? Enables the surface gradient. Defaults to true.

View all inherited from BaseComponent

View all inherited from Frame

Methods

View all inherited from Frame

Events

View all inherited from Frame

Types

type ImageSurfaceProperties = Frame & {
    Image: string?,
    ImageColor: Color3?,
    SurfaceColor: Color3?,
    Gradient: boolean?,
}

type ImageSurface = BaseComponent & Components & ImageSurfaceProperties

Function Signature

function(self, properties: ImageSurfaceProperties?): ImageSurface

Preview

Image Surface Collection Vertical Image Surface With TitleStack

Example

local imageSurface = row:Left():ImageSurface({
    Image = cascade.Symbols.house,
    SurfaceColor = Color3.fromRGB(255, 107, 53),
})

print(imageSurface:IsA("Frame")) --> true
print(imageSurface.ClassName) --> "Frame"
print(imageSurface.Type) --> "ImageSurface"