Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.apex-services.site/llms.txt

Use this file to discover all available pages before exploring further.

A lightweight, standalone progressbar for FiveM / ESX with a clean animated countdown UI. Drop-in replacement for lib.progressBar / lib.progressCircle — no code changes in your existing scripts — but also usable on its own via exports or legacy events.

​
Features

  • Clean minimal UI — bottom-centered, animated fill stripe
  • Dark + light themes — per-call color override
  • Drop-in ox_lib override — lib.progressBar and lib.progressCircle use the APEX UI
  • Legacy event compatibility — a_hud::StartProgressBar / StopProgressBar still work
  • Standalone exports — start, stop, update, isActive
  • en/de localization

​
Requirements

Required

es_extended, ox_lib

​
Configuration

config.lua
Config.DefaultColor       = 'dark'    -- 'dark' | 'light'
Config.OverrideOxLib      = true      -- replace lib.progressBar / lib.progressCircle
Config.ListenLegacyEvents = true      -- also listen to a_hud::Start/StopProgressBar
Start via export, ox_lib call, or legacy event — all paths supported. The onComplete callback gives a wasCancelled bool.
Load apex-progressbar early in server.cfg — it overrides lib.progressBar at boot, so any script using ox_lib’s progress UI inherits the APEX visuals.

​
Hooks

See Hooks reference / Progressbar. Key hooks: Hooks.OnProgressStateChanged(isActive), Hooks.ShouldBypassOverride, Hooks.ShouldCancelProgress.

​
Resource info

Code accessible: config.lua, hooks.lua, locales/*, html/*. Approximately 350 lines of Lua + NUI. Client-only logic. English + German.