progress

Documentation

Overview

Package progress provides progress indication components.

This package contains components for showing progress during long-running operations, such as spinners and progress bars.

Index

• type ProgressBar
  • func NewProgressBar(total int, message string) *ProgressBar
  • func (p *ProgressBar) SetProgress(current int, message string)
  • func (p *ProgressBar) Start()
  • func (p *ProgressBar) Stop()
  • func (p *ProgressBar) Total() int
• type Spinner
  • func NewSpinner(message string) *Spinner
  • func (s *Spinner) Start()
  • func (s *Spinner) Stop()
  • func (s *Spinner) UpdateMessage(message string)

Types

type ProgressBar

type ProgressBar struct {
	// contains filtered or unexported fields
}

ProgressBar wraps a Bubbletea progress bar for simple non-interactive use. Use this for determinate operations where you know the total count.

func NewProgressBar

func NewProgressBar(total int, message string) *ProgressBar

NewProgressBar creates a new progress bar with the given total and message.

func (*ProgressBar) SetProgress

func (p *ProgressBar) SetProgress(current int, message string)

SetProgress updates the current progress and message.

func (*ProgressBar) Start

func (p *ProgressBar) Start()

Start begins the progress bar display.

func (*ProgressBar) Stop

func (p *ProgressBar) Stop()

Stop stops the progress bar and clears the line.

func (*ProgressBar) Total

func (p *ProgressBar) Total() int

Total returns the total count for the progress bar.

type Spinner

type Spinner struct {
	// contains filtered or unexported fields
}

Spinner wraps a Bubbletea spinner for simple non-interactive use

func NewSpinner

func NewSpinner(message string) *Spinner

NewSpinner creates a new spinner with the given message

func (*Spinner) Start

func (s *Spinner) Start()

Start begins the spinner animation

func (*Spinner) Stop

func (s *Spinner) Stop()

Stop stops the spinner and clears the line

func (*Spinner) UpdateMessage

func (s *Spinner) UpdateMessage(message string)

UpdateMessage changes the spinner message