Borg/pkg/ui/progressbar.go
google-labs-jules[bot] 38fafbf639 feat: Add comprehensive docstrings and refactor matrix to tim
Add comprehensive Go docstrings with examples to all packages to achieve 100% coverage.

Refactor the `matrix` package to `tim` (Terminal Isolation Matrix). Update all references to the old package and terminology across the codebase, including commands, tests, and examples.

Fix inconsistencies in command-line flags and help text related to the refactoring.
2025-11-14 21:23:11 +00:00

24 lines
616 B
Go

package ui
import (
"github.com/schollz/progressbar/v3"
)
// NewProgressBar creates and returns a new progress bar with a standard
// set of options suitable for the application.
//
// Example:
//
// bar := ui.NewProgressBar(100, "Downloading files")
// for i := 0; i < 100; i++ {
// bar.Add(1)
// time.Sleep(10 * time.Millisecond)
// }
func NewProgressBar(total int, description string) *progressbar.ProgressBar {
return progressbar.NewOptions(total,
progressbar.OptionSetDescription(description),
progressbar.OptionSetWidth(15),
progressbar.OptionShowCount(),
progressbar.OptionClearOnFinish(),
)
}