spinner

Spinner

spinner is a simple package to add a spinner / progress indicator to any terminal application. Examples can be found below as well as full examples in the examples directory.

For more detail about the library and its features, reference your local godoc once installed.

Contributions welcome!

Installation

go get github.com/briandowns/spinner

Available Character Sets

(Numbered by their slice index)

• 1. ←↖↑↗→↘↓↙
• 1. ▁▃▄▅▆▇█▇▆▅▄▃▁
• 1. ▖▘▝▗
• 1. ┤┘┴└├┌┬┐
• 1. ◢◣◤◥
• 1. ◰◳◲◱
• 1. ◴◷◶◵
• 1. ◐◓◑◒
• 1. .oO@*
• 1. |/-\
• 1. ◡◡⊙⊙◠◠
• 1. ⣾⣽⣻⢿⡿⣟⣯⣷
• 1. >))'> >))'> >))'> >))'> >))'> <'((< <'((< <'((<
• 1. ⠁⠂⠄⡀⢀⠠⠐⠈
• 1. ⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏
• 1. abcdefghijklmnopqrstuvwxyz
• 1. ▉▊▋▌▍▎▏▎▍▌▋▊▉
• 1. ■□▪▫
• 1. ←↑→↓
• 1. ╫╪
• 1. ⇐⇖⇑⇗⇒⇘⇓⇙
• 1. ⠁⠁⠉⠙⠚⠒⠂⠂⠒⠲⠴⠤⠄⠄⠤⠠⠠⠤⠦⠖⠒⠐⠐⠒⠓⠋⠉⠈⠈
• 1. ⠈⠉⠋⠓⠒⠐⠐⠒⠖⠦⠤⠠⠠⠤⠦⠖⠒⠐⠐⠒⠓⠋⠉⠈
• 1. ⠁⠉⠙⠚⠒⠂⠂⠒⠲⠴⠤⠄⠄⠤⠴⠲⠒⠂⠂⠒⠚⠙⠉⠁
• 1. ⠋⠙⠚⠒⠂⠂⠒⠲⠴⠦⠖⠒⠐⠐⠒⠓⠋
• 1. ｦｧｨｩｪｫｬｭｮｯｱｲｳｴｵｶｷｸｹｺｻｼｽｾｿﾀﾁﾂﾃﾄﾅﾆﾇﾈﾉﾊﾋﾌﾍﾎﾏﾐﾑﾒﾓﾔﾕﾖﾗﾘﾙﾚﾛﾜﾝ
• 1. . .. ...
• 1. ▁▂▃▄▅▆▇█▉▊▋▌▍▎▏▏▎▍▌▋▊▉█▇▆▅▄▃▂▁
• 1. .oO°Oo.
• 1. +x
• 1. v<^>
• 1. >>---> >>---> >>---> >>---> >>---> <---<< <---<< <---<< <---<< <---<<
• 1. | || ||| |||| ||||| |||||| ||||| |||| ||| || |
• 1. [] [=] [==] [===] [====] [=====] [======] [=======] [========] [=========] [==========]
• 1. (*---------) (-*--------) (--*-------) (---*------) (----*-----) (-----*----) (------*---) (-------*--) (--------*-) (---------*)
• 1. █▒▒▒▒▒▒▒▒▒ ███▒▒▒▒▒▒▒ █████▒▒▒▒▒ ███████▒▒▒ ██████████

Features

• Start
• Stop
• Restart
• Reverse direction
• Update the spinner character set
• Update the spinner speed
• Prefix or append text
• Change spinner color
• Get spinner status

Examples

package main

import (
	"github.com/briandowns/spinner"
	"time"
)

func main() {
	s := spinner.New(spinner.CharSets[9], 100*time.Millisecond) // Build our new spinner
	s.Start()                                                    // Start the spinner
	time.Sleep(4 * time.Second)                                  // Run for some time to simulate work
	s.Stop()
}

Update the character set and restart the spinner

s.UpdateCharSet(spinner.CharSets[1])  // Update spinner to use a different character set
s.Restart()                           // Restart the spinner
time.Sleep(4 * time.Second)
s.Stop()

Update spin speed and restart the spinner

s.UpdateSpeed(200 * time.Millisecond) // Update the speed the spinner spins at
s.Restart()
time.Sleep(4 * time.Second)
s.Stop()

Reverse the direction of the spinner

s.Reverse() // Reverse the direction the spinner is spinning
s.Restart()
time.Sleep(4 * time.Second)
s.Stop()

Provide your own spinner

(or send me an issue or pull request to add to the project)

someSet := []string{"+", "-"}
s := spinner.New(someSet, 100*time.Millisecond)

Prefix or append text to the spinner

s.Prefix = "prefixed text: " // Prefix text before the spinner
s.Suffix = "  :appended text" // Append text after the spinner

Set or change the color of the spinner. Default color is white. This will restart the spinner with the new color.

s.Color("red") // Set the spinner color to red

Generate a sequence of numbers

setOfDigits := spinner.GenerateNumberSequence(25)    // Generate a 25 digit string of numbers
s := spinner.New(setOfDigits, 100*time.Millisecond)

Get spinner status

fmt.Println(s.ST)