Skip to main content

TitleBar

For displaying a title, and an optional close button.

Types​

TitleBarProps​

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

All Frame properties are accepted.

Content: {string}?--

The content of the title bar.

ContentSize: number?--

The size of the content text.

ContentColor: Color3?--

The color of the content text.

ContentFontFace: Font?--

The font face of the content text.

CloseButtonIcon: string?--

The icon for the close button.

CloseButtonDisabled: boolean?--

Whether the close button is disabled.

OnClose: (() → ())?--

The callback function when the close button is clicked.

}
Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "TitleBarProps",
            "desc": "",
            "fields": [
                {
                    "name": "...",
                    "lua_type": "FrameProps",
                    "desc": "All Frame properties are accepted."
                },
                {
                    "name": "Content",
                    "lua_type": "{string}?",
                    "desc": "The content of the title bar."
                },
                {
                    "name": "ContentSize",
                    "lua_type": "number?",
                    "desc": "The size of the content text."
                },
                {
                    "name": "ContentColor",
                    "lua_type": "Color3?",
                    "desc": "The color of the content text."
                },
                {
                    "name": "ContentFontFace",
                    "lua_type": "Font?",
                    "desc": "The font face of the content text."
                },
                {
                    "name": "CloseButtonIcon",
                    "lua_type": "string?",
                    "desc": "The icon for the close button."
                },
                {
                    "name": "CloseButtonDisabled",
                    "lua_type": "boolean?",
                    "desc": "Whether the close button is disabled."
                },
                {
                    "name": "OnClose",
                    "lua_type": "(() -> ())?",
                    "desc": "The callback function when the close button is clicked."
                }
            ],
            "source": {
                "line": 20,
                "path": "src/Components/TitleBar.luau"
            }
        }
    ],
    "name": "TitleBar",
    "desc": "For displaying a title, and an optional close button.",
    "source": {
        "line": 6,
        "path": "src/Components/TitleBar.luau"
    }
}