spinner

Documentation

Overview

Package spinner provides a simple wrapper around github.combriandowns/spinner to start and stop a spinner in the terminal.

Index

• type Spinner
  • func New() *Spinner
  • func (s *Spinner) Events(events []string)
  • func (s *Spinner) Start(label string)
  • func (s *Spinner) Stop(label string)

Types

type Spinner

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

Spinner represents an indicator that an asynchronous operation is taking place.

For short operations, less than 4 seconds, display only the spinner with the Start and Stop methods. For longer operations, display intermediate progress events using the Events method.

func New

func New() *Spinner

New returns a spinner that outputs to stderr.

func (*Spinner) Events

func (s *Spinner) Events(events []string)

Events writes additional information below the spinner while the spinner is still in progress. If there are already existing events under the spinner, it replaces them with the new information.

An event is displayed in a table, where columns are separated with the '\t' character.

func (*Spinner) Start

func (s *Spinner) Start(label string)

Start starts the spinner suffixed with a label.

func (*Spinner) Stop

func (s *Spinner) Stop(label string)

Stop stops the spinner and replaces it with a label.