Skip to main content

Avatar

Useful for displaying player headshots and profile pictures. And optionally, user status.

Types​

AvatarProps​

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

All Image properties are accepted.

Image: string?--

The image to display in the avatar.

RingEnabled: boolean?--

Whether the ring around the avatar is enabled.

RingColor: Color3?--

The color of the ring around the avatar.

RingThickness: number?--

The thickness of the ring around the avatar.

IndicatorEnabled: boolean?--

Whether the indicator is enabled.

IndicatorColor: Color3?--

The color of the indicator.

IndicatorIcon: string?--

The icon to display in the indicator.

IndicatorIconColor: Color3?--

The color of the indicator icon.

IndicatorCornerRadius: UDim?--

The corner radius of the indicator.

}
Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "AvatarProps",
            "desc": "",
            "fields": [
                {
                    "name": "...",
                    "lua_type": "ImageProps",
                    "desc": "All Image properties are accepted."
                },
                {
                    "name": "Image",
                    "lua_type": "string?",
                    "desc": "The image to display in the avatar."
                },
                {
                    "name": "RingEnabled",
                    "lua_type": "boolean?",
                    "desc": "Whether the ring around the avatar is enabled."
                },
                {
                    "name": "RingColor",
                    "lua_type": "Color3?",
                    "desc": "The color of the ring around the avatar."
                },
                {
                    "name": "RingThickness",
                    "lua_type": "number?",
                    "desc": "The thickness of the ring around the avatar."
                },
                {
                    "name": "IndicatorEnabled",
                    "lua_type": "boolean?",
                    "desc": "Whether the indicator is enabled."
                },
                {
                    "name": "IndicatorColor",
                    "lua_type": "Color3?",
                    "desc": "The color of the indicator."
                },
                {
                    "name": "IndicatorIcon",
                    "lua_type": "string?",
                    "desc": "The icon to display in the indicator."
                },
                {
                    "name": "IndicatorIconColor",
                    "lua_type": "Color3?",
                    "desc": "The color of the indicator icon."
                },
                {
                    "name": "IndicatorCornerRadius",
                    "lua_type": "UDim?",
                    "desc": "The corner radius of the indicator."
                }
            ],
            "source": {
                "line": 22,
                "path": "src/Components/Avatar.luau"
            }
        }
    ],
    "name": "Avatar",
    "desc": "Useful for displaying player headshots and profile pictures. And optionally, user status.",
    "source": {
        "line": 6,
        "path": "src/Components/Avatar.luau"
    }
}