spin

Documentation

Index

• Variables
• func Until(stdout io.Writer, msg string, ctrl chan bool)
• type Spinner
  • func New() *Spinner
  • func (s *Spinner) Current() string
  • func (s *Spinner) Next() string
  • func (s *Spinner) Reset()
  • func (s *Spinner) Set(frames string)

Variables

var (
	Box1    = `⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏`
	Box2    = `⠋⠙⠚⠞⠖⠦⠴⠲⠳⠓`
	Box3    = `⠄⠆⠇⠋⠙⠸⠰⠠⠰⠸⠙⠋⠇⠆`
	Box4    = `⠋⠙⠚⠒⠂⠂⠒⠲⠴⠦⠖⠒⠐⠐⠒⠓⠋`
	Box5    = `⠁⠉⠙⠚⠒⠂⠂⠒⠲⠴⠤⠄⠄⠤⠴⠲⠒⠂⠂⠒⠚⠙⠉⠁`
	Box6    = `⠈⠉⠋⠓⠒⠐⠐⠒⠖⠦⠤⠠⠠⠤⠦⠖⠒⠐⠐⠒⠓⠋⠉⠈`
	Box7    = `⠁⠁⠉⠙⠚⠒⠂⠂⠒⠲⠴⠤⠄⠄⠤⠠⠠⠤⠦⠖⠒⠐⠐⠒⠓⠋⠉⠈⠈`
	Spin1   = `|/-\`
	Spin2   = `◴◷◶◵`
	Spin3   = `◰◳◲◱`
	Spin4   = `◐◓◑◒`
	Spin5   = `▉▊▋▌▍▎▏▎▍▌▋▊▉`
	Spin6   = `▌▄▐▀`
	Spin7   = `╫╪`
	Spin8   = `■□▪▫`
	Spin9   = `←↑→↓`
	Default = Box1
)

Spinner types.

Functions

func Until

func Until(stdout io.Writer, msg string, ctrl chan bool)

Until - Spin until ctrl channel signals

Types

type Spinner

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

Spinner is exactly what you think it is.

func New

func New() *Spinner

New returns a spinner initialized with Default frames.

func (*Spinner) Current

func (s *Spinner) Current() string

Current returns the current rune in the sequence.

func (*Spinner) Next

func (s *Spinner) Next() string

Next returns the next rune in the sequence.

func (*Spinner) Reset

func (s *Spinner) Reset()

Reset the spinner to its initial frame.

func (*Spinner) Set

func (s *Spinner) Set(frames string)

Set frames to the given string which must not use spaces.