Struct ProgressBar 

pub struct ProgressBar {
    pub current: usize,
    pub total: usize,
    pub label: Option<String>,
    pub show_percentage: bool,
    pub bar_style: Style,
    pub label_style: Style,
}

A configurable progress bar widget.

Rendering modes

Field	Effect
label	Rendered after the bar, right-aligned in a row
show_percentage	Appends " N%" after the bar (and after label)

Both may be enabled simultaneously.

Examples

use zlayer_tui::widgets::progress_bar::ProgressBar;

// Minimal usage -- just a bar
let bar = ProgressBar::new(3, 10);

// Builder-style with label
let bar = ProgressBar::new(3, 10).with_label("Step 3/10");

// Deploy-style with percentage
let bar = ProgressBar::new(3, 10).with_percentage();

// Compact string for embedding in table cells
let text = ProgressBar::new(3, 10).with_percentage().to_string_compact(20);

Fields

current: usize

total: usize

label: Option<String>

show_percentage: bool

bar_style: Style

label_style: Style

Implementations

impl ProgressBar

pub fn new(current: usize, total: usize) -> Self

Create a new progress bar with sensible defaults.

Defaults: no label, no percentage, bar styled with ACCENT foreground, label styled with TEXT foreground.

pub fn with_label(self, label: impl Into<String>) -> Self

Attach a text label that will be rendered after the bar.

pub fn with_percentage(self) -> Self

Enable a trailing percentage indicator (e.g. " 30%").

pub fn to_string_compact(&self, width: usize) -> String

Produce a compact string representation suitable for embedding inside table cells or log lines.

The returned string has the form "████░░░░ label N%" depending on which display options are enabled. The bar itself occupies exactly width columns; the suffix is appended after a space.

If total is zero the bar is empty but still occupies width columns.

Trait Implementations

impl Widget for ProgressBar

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.