> ## Documentation Index
> Fetch the complete documentation index at: https://lationscripts.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Modern UI - Progress
> Progress bar with optional multi-step feature & more
## Quick Start
```lua theme={null}
local success = exports.lation_ui:progressBar({
label = 'Processing',
description = 'Please wait...',
duration = 5000,
icon = 'fas fa-spinner'
})
if success then
print('Progress completed')
else
print('Progress cancelled')
end
```
## Functions
Show a progress bar to the player.
```lua theme={null}
local success = exports.lation_ui:progressBar(data)
```
**Parameters:**
* `data` (table) - Progress bar configuration object (see [Options](#options))
**Returns:**
* `success` (boolean) - `true` if completed, `false` if cancelled/failed
Check if a progress bar is currently active.
```lua theme={null}
local isActive = exports.lation_ui:progressActive()
```
**Returns:**
* `isActive` (boolean) - `true` if progress is active, `false` otherwise
Cancel the currently active progress bar.
```lua theme={null}
exports.lation_ui:cancelProgress()
```
## Configuration
### Options
Progress bar label text
Progress description text
Overridden by steps if multi-step feature is used
Duration in milliseconds
FontAwesome icon class
Icon color (hex or [CSS color name](https://htmlcolorcodes.com/color-names/))
Icon animation type
Available options: `'spin'`, `'spinPulse'`, `'spinReverse'`, `'pulse'`, `'beat'`, `'fade'`, `'beatFade'`, `'bounce'`, `'shake'`
Progress bar color (hex or [CSS color name](https://htmlcolorcodes.com/color-names/))
Array of step objects with descriptions for multi-step progress (see [Steps](#steps))
Whether progress can be cancelled with X key
Allow progress while player is dead
Allow progress while player is ragdolled
Allow progress while player is cuffed
Allow progress while player is falling
Allow progress while player is swimming
Animation configuration (see [Animations](#animations))
Prop configuration (see [Props](#props))
Controls to disable during progress (see [Disable](#disable))
### Steps
Each step object in the `steps` array supports:
Description text for this step
**Example:**
```lua theme={null}
steps = {
{ description = 'Connecting to server...' },
{ description = 'Bypassing security protocols...' },
{ description = 'Establishing secure connection...' },
{ description = 'Hack in progress...' }
}
```
### Animations
Animation dictionary
Either `dict` or `scenario` is required if using animations
Animation clip name
Animation flags
Blend in speed
Blend out speed
Animation duration (-1 for loop)
Playback rate
Lock X axis
Lock Y axis
Lock Z axis
Scenario name (alternative to dict/clip)
Either `dict` or `scenario` is required if using animations
Play enter animation for scenarios
### Props
Prop model hash
Bone index to attach prop to
Position offset as table: `{x, y, z}`
Rotation offset as table: `{x, y, z}`
Rotation order
### Disable
Disable player movement
Disable sprinting only
Disable vehicle controls
Disable combat actions
Disable mouse look
## Preview
