spinner

package

v0.14.0 Latest Latest Go to latest Published: Mar 19, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation ¶

const (
	Complete spinnerStatus = iota
	Error
	Suspended
	Awaiting
	Progressing
)

This section is empty.

func IsTerminal() bool

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

Spinner manages a single spinner

func NewSpinner(options SpinnerOptions) *Spinner

NewSpinner creates a new spinner instance.

func (s *Spinner) GetMessage() string

GetMessage returns the current spinner message.

func (s *Spinner) Print(w io.Writer, char string)

Print prints the spinner at a given position.

func (s *Spinner) SetStatus(status spinnerStatus)

SetStatus defines the status of the spinner.

func (s *Spinner) UpdateMessage(message string)

UpdateMessage updates the spinner message.

func (s *Spinner) UpdateMessagef(format string, a ...interface{})

UpdateMessagef updates the spinner message with a formatted string.

type SpinnerManager interface {
	AddSpinner(msg string) *Spinner
	GetSpinners() []*Spinner
	SetSpinnersCount(count int)
	Start()
	Stop()
}

SpinnerManager manages spinners

func NewSpinnerManager(ctx context.Context) SpinnerManager

constructor for the SpinnerManager.

type SpinnerOptions struct {
	Message   string
	HasUpdate chan bool
}