Skip to main content

Image

Equivalent to Roblox's ImageLabel.

Types​

ImageProps​

</>
interface ImageProps {
...: BaseProps--

All Base properties are accepted.

Image: string?--

The image asset ID to display.

FallbackImage: string?--

The fallback image asset ID to display if Image is not provided.

ImageColor3: Color3?--

The color to apply to the image.

ImageTransparency: number?--

The transparency of the image.

ImageRectOffset: Vector2?--

The offset of the image rectangle.

ImageRectSize: Vector2?--

The size of the image rectangle.

ResampleMode: Enum.ResamplerMode?--

The resampling mode for the image.

ScaleType: Enum.ScaleType?--

The scaling mode for the image.

SliceCenter: Rect?--

The center rectangle for 9-slice scaling.

SliceScale: number?--

The scale factor for 9-slice scaling.

TileSize: UDim2?--

The size of the tile for tiled images.

}
Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "ImageProps",
            "desc": "",
            "fields": [
                {
                    "name": "...",
                    "lua_type": "BaseProps",
                    "desc": "All Base properties are accepted."
                },
                {
                    "name": "Image",
                    "lua_type": "string?",
                    "desc": "The image asset ID to display."
                },
                {
                    "name": "FallbackImage",
                    "lua_type": "string?",
                    "desc": "The fallback image asset ID to display if `Image` is not provided."
                },
                {
                    "name": "ImageColor3",
                    "lua_type": "Color3?",
                    "desc": "The color to apply to the image."
                },
                {
                    "name": "ImageTransparency",
                    "lua_type": "number?",
                    "desc": "The transparency of the image."
                },
                {
                    "name": "ImageRectOffset",
                    "lua_type": "Vector2?",
                    "desc": "The offset of the image rectangle."
                },
                {
                    "name": "ImageRectSize",
                    "lua_type": "Vector2?",
                    "desc": "The size of the image rectangle."
                },
                {
                    "name": "ResampleMode",
                    "lua_type": "Enum.ResamplerMode?",
                    "desc": "The resampling mode for the image."
                },
                {
                    "name": "ScaleType",
                    "lua_type": "Enum.ScaleType?",
                    "desc": "The scaling mode for the image."
                },
                {
                    "name": "SliceCenter",
                    "lua_type": "Rect?",
                    "desc": "The center rectangle for 9-slice scaling."
                },
                {
                    "name": "SliceScale",
                    "lua_type": "number?",
                    "desc": "The scale factor for 9-slice scaling."
                },
                {
                    "name": "TileSize",
                    "lua_type": "UDim2?",
                    "desc": "The size of the tile for tiled images."
                }
            ],
            "source": {
                "line": 24,
                "path": "src/Components/Image.luau"
            }
        }
    ],
    "name": "Image",
    "desc": "Equivalent to Roblox's `ImageLabel`.",
    "source": {
        "line": 6,
        "path": "src/Components/Image.luau"
    }
}