Skip to content

Progress Bar

Used to show progress visually.

Updates

percentage number (0.0)
A value between 0.0 and 1.0
showLabel boolean (false)
Adds the percentage as text to the progress bar
ariaLabel string (nil)
A value to set the aria label (used for accessibility/screen readers)
isStriped boolean (false)
If the progress bar should have a stripped animation added to it.
color BSColor (nil)
The color of the progress bar

Examples

{
  percentage = 0.0,
  showLabel = true,
  color = "success",
}

local p = 0.33
{
  percentage = p,
  showLabel = true,
  ariaLabel = "Battle Royal map progress",
  isStripped = isCircleShrinking(),
  color = p < 0.7 and "success" or p < 0.9 and "warning" else "error",
}

See Also