Skip to main content

Constants

This module exposes values that are read from in various components. These can be used to, for example, match the appearance of custom components with components from this library.

warning

The table returned by this module is read-only. It is not a config.

Properties​

DefaultFont​

</>
Constants.DefaultFont: Font

The default font for text.

DefaultTextSize​

</>
Constants.DefaultTextSize: number

The default size for text.

DefaultButtonHeight​

</>
Constants.DefaultButtonHeight: number

The default height of buttons.

DefaultToggleHeight​

</>
Constants.DefaultToggleHeight: number

The default height of toggles (Checkbox and RadioButton).

DefaultInputHeight​

</>
Constants.DefaultInputHeight: number

The default height of text and numeric inputs.

DefaultSliderHeight​

</>
Constants.DefaultSliderHeight: number

The default height of sliders.

DefaultDropdownHeight​

</>
Constants.DefaultDropdownHeight: number

The default height of the permanent section of dropdowns.

DefaultDropdownRowHeight​

</>
Constants.DefaultDropdownRowHeight: number

The default height of rows in dropdown lists.

DefaultProgressBarHeight​

</>
Constants.DefaultProgressBarHeight: number

The default height of progress bars.

DefaultColorPickerSize​

</>
Constants.DefaultColorPickerSize: UDim2

The default window size of color pickers.

DefaultNumberSequencePickerSize​

</>
Constants.DefaultNumberSequencePickerSize: UDim2

The default window size of number sequence pickers.

DefaultDatePickerSize​

</>
Constants.DefaultDatePickerSize: UDim2

The default window size of date pickers.

Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "DefaultFont",
            "desc": "The default font for text.",
            "lua_type": "Font",
            "source": {
                "line": 17,
                "path": "src/Constants.luau"
            }
        },
        {
            "name": "DefaultTextSize",
            "desc": "The default size for text.",
            "lua_type": "number",
            "source": {
                "line": 22,
                "path": "src/Constants.luau"
            }
        },
        {
            "name": "DefaultButtonHeight",
            "desc": "The default height of buttons.",
            "lua_type": "number",
            "source": {
                "line": 27,
                "path": "src/Constants.luau"
            }
        },
        {
            "name": "DefaultToggleHeight",
            "desc": "The default height of toggles (Checkbox and RadioButton).",
            "lua_type": "number",
            "source": {
                "line": 32,
                "path": "src/Constants.luau"
            }
        },
        {
            "name": "DefaultInputHeight",
            "desc": "The default height of text and numeric inputs.",
            "lua_type": "number",
            "source": {
                "line": 37,
                "path": "src/Constants.luau"
            }
        },
        {
            "name": "DefaultSliderHeight",
            "desc": "The default height of sliders.",
            "lua_type": "number",
            "source": {
                "line": 42,
                "path": "src/Constants.luau"
            }
        },
        {
            "name": "DefaultDropdownHeight",
            "desc": "The default height of the permanent section of dropdowns.",
            "lua_type": "number",
            "source": {
                "line": 47,
                "path": "src/Constants.luau"
            }
        },
        {
            "name": "DefaultDropdownRowHeight",
            "desc": "The default height of rows in dropdown lists.",
            "lua_type": "number",
            "source": {
                "line": 52,
                "path": "src/Constants.luau"
            }
        },
        {
            "name": "DefaultProgressBarHeight",
            "desc": "The default height of progress bars.",
            "lua_type": "number",
            "source": {
                "line": 57,
                "path": "src/Constants.luau"
            }
        },
        {
            "name": "DefaultColorPickerSize",
            "desc": "The default window size of color pickers.",
            "lua_type": "UDim2",
            "source": {
                "line": 62,
                "path": "src/Constants.luau"
            }
        },
        {
            "name": "DefaultNumberSequencePickerSize",
            "desc": "The default window size of number sequence pickers.",
            "lua_type": "UDim2",
            "source": {
                "line": 67,
                "path": "src/Constants.luau"
            }
        },
        {
            "name": "DefaultDatePickerSize",
            "desc": "The default window size of date pickers.",
            "lua_type": "UDim2",
            "source": {
                "line": 72,
                "path": "src/Constants.luau"
            }
        }
    ],
    "types": [],
    "name": "Constants",
    "desc": "This module exposes values that are read from in various components.\nThese can be used to, for example, match the appearance of custom components with components\nfrom this library.\n\n:::warning\nThe table returned by this module is read-only. It is not a config.\n:::",
    "source": {
        "line": 11,
        "path": "src/Constants.luau"
    }
}