Skip to main content

Badge

Used to inform the user of something's status. E.g. a notification indicator or discount tag.

Types​

BadgeProps​

</>
interface BadgeProps {
...: FrameProps--

All Frame properties are accepted.

Content: {string}?--

The content to display inside the badge.

ContentWrapped: boolean?--

Whether the content should wrap if it overflows.

Color: Color3?--

The background color of the badge.

ContentColor: Color3?--

The color of the content inside the badge.

ContentSize: number?--

The size of the content inside the badge.

}
Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "BadgeProps",
            "desc": "",
            "fields": [
                {
                    "name": "...",
                    "lua_type": "FrameProps",
                    "desc": "All Frame properties are accepted."
                },
                {
                    "name": "Content",
                    "lua_type": "{string}?",
                    "desc": "The content to display inside the badge."
                },
                {
                    "name": "ContentWrapped",
                    "lua_type": "boolean?",
                    "desc": "Whether the content should wrap if it overflows."
                },
                {
                    "name": "Color",
                    "lua_type": "Color3?",
                    "desc": "The background color of the badge."
                },
                {
                    "name": "ContentColor",
                    "lua_type": "Color3?",
                    "desc": "The color of the content inside the badge."
                },
                {
                    "name": "ContentSize",
                    "lua_type": "number?",
                    "desc": "The size of the content inside the badge."
                }
            ],
            "source": {
                "line": 19,
                "path": "src/Components/Badge.luau"
            }
        }
    ],
    "name": "Badge",
    "desc": "Used to inform the user of something's status. E.g. a notification indicator or discount tag.",
    "source": {
        "line": 7,
        "path": "src/Components/Badge.luau"
    }
}