Skip to content

Guides

Step-by-step guides for using loaders.zig in your Zig applications.

Getting Started

  • Getting Started — install the library, create your first progress bar and spinner, and learn the core concepts (thread modes, rendering, writing output).

Core Concepts

  • Thread modes.none (manual), .auto (background thread), .external (caller-driven).
  • Auto-start — bars and spinners start automatically on first update (setProgress, tick, tickFrame) when left in the .pending state.
  • Templates — every widget renders through the template engine; see Templates for all tokens.
  • Writing output — always use loaders.stdoutWriter(io) (returns a pointer) to write lines after a widget; see Terminal Helpers.

Quick Reference

TopicLink
Progress BarAPI
SpinnerAPI
Block BarAPI
IndeterminateAPI
MultiBarAPI
BatchRunnerAPI
StepSequenceAPI
Templates & FormattersAPI
Terminal HelpersAPI
All examplesExamples

Released under the MIT License.