Skip to main content

ProgressBar

Useful for communicating progress towards goals.

Types​

ProgressBarProps​

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

All Frame properties are accepted.

Inverted: boolean?--

Whether the progress bar is inverted.

Progress: number?--

The progress value, ranging from 0 to 1.

Color: Color3?--

The color of the progress fill.

Direction: Enum.FillDirection?--

The direction of the progress bar (Horizontal or Vertical).

Length: UDim?--

The length of the progress bar.

}
Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "ProgressBarProps",
            "desc": "",
            "fields": [
                {
                    "name": "...",
                    "lua_type": "FrameProps",
                    "desc": "All Frame properties are accepted."
                },
                {
                    "name": "Inverted",
                    "lua_type": "boolean?",
                    "desc": "Whether the progress bar is inverted."
                },
                {
                    "name": "Progress",
                    "lua_type": "number?",
                    "desc": "The progress value, ranging from 0 to 1."
                },
                {
                    "name": "Color",
                    "lua_type": "Color3?",
                    "desc": "The color of the progress fill."
                },
                {
                    "name": "Direction",
                    "lua_type": "Enum.FillDirection?",
                    "desc": "The direction of the progress bar (Horizontal or Vertical)."
                },
                {
                    "name": "Length",
                    "lua_type": "UDim?",
                    "desc": "The length of the progress bar."
                }
            ],
            "source": {
                "line": 18,
                "path": "src/Components/ProgressBar.luau"
            }
        }
    ],
    "name": "ProgressBar",
    "desc": "Useful for communicating progress towards goals.",
    "source": {
        "line": 6,
        "path": "src/Components/ProgressBar.luau"
    }
}