Block Bar

A BlockProgressBar is a ProgressBar with block characters (█) and partial fills (▏▎▍▌▋▊▉) for smooth sub-character progress.

const bar = try loaders.BlockProgressBar.init(allocator, io, config);

Config

pub const BlockBarConfig = struct {
    total: u64,                         // required
    current: u64 = 0,
    min_progress: u64 = 0,
    width: u32 = 40,
    style: BlockBarStyle = .{},
    template: []const u8 = "{bar} {percent}%",
    prefix: ?[]const u8 = null,
    suffix: ?[]const u8 = null,
    text: ?[]const u8 = null,
    color: ?[]const u8 = null,
    text_style: FontStyle = .{},
    formatters: FormatterSet = .{},
    thread_mode: ThreadMode = .none,
    interval_ms: u32 = 16,
    direction: Direction = .incremental,
    on_tick: ?Callback = null,
    on_finish: ?Callback = null,
    on_pause: ?Callback = null,
    on_resume: ?Callback = null,
    ctx: ?*anyopaque = null,
};

BlockBarStyle

pub const BlockBarStyle = struct {
    filled: []const u8 = "█",
    empty: []const u8 = " ",
    left_bracket: []const u8 = "",
    right_bracket: []const u8 = "",
};

Partial fills are always the block-partial set ▏▎▍▌▋▊▉.

Methods

Same as ProgressBar minus setStyle:

init, deinit, start, tick, setProgress, pause, continue_, forceRedraw, finish(FinishConfig), fail(message), setText, setPrefix, setSuffix, setColor, setTemplate, state() BlockState, getStatus, getCurrent.

Example

var bar = try loaders.BlockProgressBar.init(allocator, io, .{
    .total = 100,
    .width = 30,
    .template = "{bar} {percent}%",
    .text = "Uploading",
});
defer bar.deinit();

var i: u64 = 0;
while (i <= 100) : (i += 1) {
    bar.setProgress(i);
    loaders.sleepMs(io, 30);
}
bar.finish(.{ .newline = true });