> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sirius.menu/llms.txt
> Use this file to discover all available pages before exploring further.
# Progress
> A read-only bar showing how far along something is.
Sentivel
Endorsed by RayfieldStatus pages and uptime monitoring for whatever you ship. Free to start.
Take a look
→
Preview only. This is on the [preview channel](/rayfield-gen2/preview) and is not in the stable release. It can change or be dropped before it lands there.
A progress bar shows how far through a range a value sits. It takes a range the way a slider does, reads as a percentage unless you say otherwise, and is read-only - it carries no flag and saves nothing.
```lua theme={null}
local download = tab:CreateProgress({
name = "Download",
range = { 0, 100 },
value = 35,
})
download:Set(80)
```
Set `steps` to draw the track as a row of segments instead of one continuous fill, for something that moves through stages rather than a distance.
```lua theme={null}
tab:CreateProgress({ name = "Setup", steps = 5, value = 2 }) -- reads "2/5"
```
Set `indeterminate` when you don't know how long the work will take. The bar sweeps instead of filling, and the first `Set` ends the sweep.
```lua theme={null}
local syncing = tab:CreateProgress({ name = "Syncing", indeterminate = true })
syncing:Set(1) -- done sweeping, now showing a value
```
## Properties
The label.
Hint text under the label. Optional.
An icon shown beside the label. Optional.
The bounds, as `{ min, max }`. With `steps` set and no range given, it defaults to `{ 0, steps }` so the value counts stages.
The initial value. Anything outside the range is clamped.
Draw the track as this many segments. Needs at least 2; anything less is ignored and the bar stays continuous.
A fixed readout beside the label, in place of the percentage.
Build the readout yourself: `(value, min, max) -> string`. Ignored while `text` is set.
Set false to hide the readout and show the track alone.
Sweep instead of filling, for work of unknown length.
## Handle
The current value.
Set the value. Ends the sweep if the bar was indeterminate.
The current value.
Where the value sits in its range, 0 to 1.
Move the bounds. The value comes with them, clamped to whatever the new range allows.
Replace the readout, or pass nothing to go back to the formatter or the percentage.
Switch between a real value and the waiting sweep.