Loader¶
Loader is a set of loading animations. Choose one with Kind. All of them are square, so they fit the same layouts.
Usage¶
Call Components.Loader with a scope and a table of properties:
C.Loader(scope, { Kind = "Orbit", SizePx = 36 })
C.Loader(scope, { Kind = "Icon", Icon = "refresh-cw", Motion = "Spin" })
Kinds¶
| Kind | Description |
|---|---|
"Beachball" |
A spinning rainbow pinwheel, as on macOS. |
"Dots" |
Three bouncing dots. |
"Bars" |
Bars that move up and down like an equaliser. |
"Ripple" |
Rings that spread out from a dot in the middle. |
"Orbit" |
Dots that chase each other around a circle. |
"Gnome" |
A thin ring with a small dot circling it, with a fading trail. |
"Icon" |
A Lucide icon with a motion: "Spin", "Pulse", "Bounce", "Flip" or "Wiggle". |
Conical gradients¶
The beachball uses a conical UIGradient if the engine supports it. If not, it uses stacked discs. See Flags.
Properties¶
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
Theme |
ThemeRef |
 |
The contextual theme | Theme to use for this component instead of the one from Theme.Provide. |
LayoutOrder |
UsedAs<number> |
|
0 |
Position in a parent UIListLayout or UIGridLayout. |
Size |
UsedAs<UDim2> |
|
- | Size of the component. |
Visible |
UsedAs<boolean> |
|
true |
Whether the component is shown. |
ZIndex |
UsedAs<number> |
|
- | Z index of the component. |
Kind |
LoaderKind |
|
"Dots" |
Which loader to draw. |
SizePx |
number |
|
32 |
Width and height, in pixels. |
Color |
Color3 |
|
Colors.Primary |
Colour of the loader. The beachball ignores this, because it is a rainbow. |
Icon |
string |
|
"loader" |
"Icon" only. Name of a Lucide icon. |
Motion |
LoaderMotion |
|
"Spin" |
"Icon" only. The motion of the icon. |