Skip to main content

BaseButton

A barebones button component, like if Roblox had a "Button" class rather than only a TextButton.

Types​

BaseButtonProps​

</>
interface BaseButtonProps {
...: BaseProps
Disabled: Fusion.UsedAs<boolean>?
OnActivated: Fusion.UsedAs<() → ()>?
OnMouseEnter: Fusion.UsedAs<() → ()>?
OnMouseLeave: Fusion.UsedAs<() → ()>?
OnMouseButton1Down: Fusion.UsedAs<() → ()>?
OnMouseButton1Up: Fusion.UsedAs<() → ()>?
IsHovering: Fusion.UsedAs<boolean>?
IsHolding: Fusion.UsedAs<boolean>?
HoverSound: Fusion.UsedAs<Sound>?
ClickSound: Fusion.UsedAs<Sound>?
}
Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "BaseButtonProps",
            "desc": "",
            "fields": [
                {
                    "name": "...",
                    "lua_type": "BaseProps",
                    "desc": ""
                },
                {
                    "name": "Disabled",
                    "lua_type": "Fusion.UsedAs<boolean>?",
                    "desc": ""
                },
                {
                    "name": "OnActivated",
                    "lua_type": "Fusion.UsedAs<() -> ()>?",
                    "desc": ""
                },
                {
                    "name": "OnMouseEnter",
                    "lua_type": "Fusion.UsedAs<() -> ()>?",
                    "desc": ""
                },
                {
                    "name": "OnMouseLeave",
                    "lua_type": "Fusion.UsedAs<() -> ()>?",
                    "desc": ""
                },
                {
                    "name": "OnMouseButton1Down",
                    "lua_type": "Fusion.UsedAs<() -> ()>?",
                    "desc": ""
                },
                {
                    "name": "OnMouseButton1Up",
                    "lua_type": "Fusion.UsedAs<() -> ()>?",
                    "desc": ""
                },
                {
                    "name": "IsHovering",
                    "lua_type": "Fusion.UsedAs<boolean>?",
                    "desc": ""
                },
                {
                    "name": "IsHolding",
                    "lua_type": "Fusion.UsedAs<boolean>?",
                    "desc": ""
                },
                {
                    "name": "HoverSound",
                    "lua_type": "Fusion.UsedAs<Sound>?",
                    "desc": ""
                },
                {
                    "name": "ClickSound",
                    "lua_type": "Fusion.UsedAs<Sound>?",
                    "desc": ""
                }
            ],
            "source": {
                "line": 39,
                "path": "src/Components/BaseButton.luau"
            }
        }
    ],
    "name": "BaseButton",
    "desc": "A barebones button component, like if Roblox had a \"`Button`\" class rather than only a `TextButton`.",
    "source": {
        "line": 6,
        "path": "src/Components/BaseButton.luau"
    }
}