spinner

Documentation

Index

• Constants
• type Option
  • func WithSequence(sequence string) Option
  • func WithSpeed(speed time.Duration) Option
• type Spinner
  • func New(options ...Option) *Spinner
  • func (s *Spinner) Start()
  • func (s *Spinner) StartContext(ctx context.Context)
  • func (s *Spinner) Stop()

Constants

const (
	DefaultSpeed    = 100 * time.Millisecond
	DefaultSequence = Sequence7

	Sequence1  = "▁▂▃▄▅▆▇█▇▆▅▄▃▂"
	Sequence2  = "▁▂▃▄▅▆▇█"
	Sequence3  = "█▉▊▋▌▍▍▎▏"
	Sequence4  = "◇◈◆◈"
	Sequence5  = "◇□"
	Sequence6  = "◐◓◑◒"
	Sequence7  = "⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏"
	Sequence8  = "▲▴▶▸▼▾◀◂"
	Sequence9  = "◜◠◝◞◡◟"
	Sequence10 = "◇◊|◊"
	Sequence11 = "◦○◎◯◎○"
	Sequence12 = "←↖↑↗→↘↓↙"
	Sequence13 = "▖▘▝▗"
	Sequence14 = "◰◳◲◱"
	Sequence15 = "◴◷◶◵"
	Sequence16 = "⣾⣽⣻⢿⡿⣟⣯⣷"
)

Types

type Option

type Option func(*Spinner)

Option is the type for functional options.

func WithSequence

func WithSequence(sequence string) Option

WithSequence sets the current sequence.

func WithSpeed

func WithSpeed(speed time.Duration) Option

type Spinner

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

func New

func New(options ...Option) *Spinner

New creates a new Spinner, applying all the provided functional options.

func (*Spinner) Start

func (s *Spinner) Start()

func (*Spinner) StartContext

func (s *Spinner) StartContext(ctx context.Context)

func (*Spinner) Stop

func (s *Spinner) Stop()