progressbar

Documentation

Overview

Package progressbar provides ProgressBar, a single-line visual progress indicator with optional percentage label.

Index

• type ProgressBar
  • func New(bounds geom.Rect, min, max int) *ProgressBar
  • func (p *ProgressBar) Draw()
  • func (p *ProgressBar) GetTypeID() string
  • func (p *ProgressBar) Reset()
  • func (p *ProgressBar) SetProgress(v int)
  • func (p *ProgressBar) SetRange(min, max int)

Types

type ProgressBar

type ProgressBar struct {
	views.Base

	Min, Max    int
	Position    int
	ShowPercent bool
	FilledChar  rune
	EmptyChar   rune
}

ProgressBar is a [Min..Max] gauge filled left-to-right.

func New

func New(bounds geom.Rect, min, max int) *ProgressBar

New constructs a ProgressBar with range [min..max].

func (*ProgressBar) Draw

func (p *ProgressBar) Draw()

Draw paints the bar.

func (*ProgressBar) GetTypeID

func (p *ProgressBar) GetTypeID() string

GetTypeID for the serial registry.

func (*ProgressBar) Reset

func (p *ProgressBar) Reset()

Reset returns the position to Min.

func (*ProgressBar) SetProgress

func (p *ProgressBar) SetProgress(v int)

SetProgress clamps v to [Min, Max] and stores it.

func (*ProgressBar) SetRange

func (p *ProgressBar) SetRange(min, max int)

SetRange installs a new (min, max), clamping the current position.