progressbar

Documentation

Index

• type Option
  • func WithEmptyColor(c color.Color) Option
  • func WithFillColor(c color.Color) Option
• type ProgressBar
  • func New(width int, percentage float64, opts ...Option) ProgressBar
  • func (p ProgressBar) Render() string
• type SegmentedOption
  • func WithSegmentWidth(w int) SegmentedOption
  • func WithSegmentedColors(poor, sufficient, optimal color.Color) SegmentedOption
  • func WithSegmentedThresholds(sufficient, optimal float64) SegmentedOption
• type SegmentedProgressBar
  • func NewSegmented(percentage float64, opts ...SegmentedOption) SegmentedProgressBar
  • func (s SegmentedProgressBar) Render() string

Types

type Option

type Option func(*ProgressBar)

func WithEmptyColor

func WithEmptyColor(c color.Color) Option

func WithFillColor

func WithFillColor(c color.Color) Option

type ProgressBar

type ProgressBar struct {
	Width      int
	Percentage float64
	FillColor  color.Color
	EmptyColor color.Color
}

func New

func New(width int, percentage float64, opts ...Option) ProgressBar

func (ProgressBar) Render

func (p ProgressBar) Render() string

type SegmentedOption

type SegmentedOption func(*SegmentedProgressBar)

func WithSegmentWidth

func WithSegmentWidth(w int) SegmentedOption

func WithSegmentedColors

func WithSegmentedColors(poor, sufficient, optimal color.Color) SegmentedOption

func WithSegmentedThresholds

func WithSegmentedThresholds(sufficient, optimal float64) SegmentedOption

WithSegmentedThresholds sets custom thresholds for sufficient and optimal.

type SegmentedProgressBar

type SegmentedProgressBar struct {
	Width               int
	Percentage          float64
	PoorColor           color.Color // below SufficientThreshold
	SufficientColor     color.Color // SufficientThreshold to OptimalThreshold
	OptimalColor        color.Color // above OptimalThreshold
	DimColor            color.Color
	SegmentWidth        int
	SufficientThreshold float64 // threshold for sufficient (default 70)
	OptimalThreshold    float64 // threshold for optimal (default 85)
}

SegmentedProgressBar represents a 3-segment progress bar where only the active segment is highlighted based on the percentage range

func NewSegmented

func NewSegmented(percentage float64, opts ...SegmentedOption) SegmentedProgressBar

func (SegmentedProgressBar) Render

func (s SegmentedProgressBar) Render() string