Help us shape the future of Go! Take the 2026 Go Developer Survey

ui

package
v1.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 6, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var DisableProgress = false

DisableProgress can be set to true in tests to prevent pterm goroutines from spawning and causing race conditions.

Out is the writer used for spinner output. Tests may replace it.

Functions

This section is empty.

Types

type MultiSpinner

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

MultiSpinner manages multiple concurrent spinners.

func NewMultiSpinner

func NewMultiSpinner() (*MultiSpinner, error)

NewMultiSpinner creates a new multi-spinner manager.

func (*MultiSpinner) AddSpinner

func (m *MultiSpinner) AddSpinner(text string) *pterm.SpinnerPrinter

AddSpinner adds a new spinner to the multi-printer display.

func (*MultiSpinner) Stop

func (m *MultiSpinner) Stop()

Stop stops the multi-printer.

type Spinner

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

Spinner wraps the mpb.Progress container and a single bar. It's designed to manage a single progress bar and allow logging messages above the bar without disrupting it.

func NewProgressSpinner

func NewProgressSpinner(message string) *Spinner

NewProgressSpinner creates a spinner that displays progress as a bar.

func NewSpinner

func NewSpinner(message string) *Spinner

NewSpinner creates a new spinner with a default indeterminate style.

func (*Spinner) Logf

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

Logf prints a formatted message above the progress bar.

func (*Spinner) SetProgressBar

func (s *Spinner) SetProgressBar(progress float64, msg ...string)

SetProgressBar sets the progress of the bar. Progress should be from 0.0 to 1.0.

func (*Spinner) Start

func (s *Spinner) Start()

Start does nothing in this implementation, as the bar is visible on creation.

func (*Spinner) Stop

func (s *Spinner) Stop()

Stop marks the bar as completed and waits for the progress container to finish.

func (*Spinner) UpdateMessage

func (s *Spinner) UpdateMessage(msg string)

UpdateMessage updates the message displayed next to the spinner/bar.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL