README
¶
round
Go command line spinner.
About
Package round is a command line spinner. Start one with Go.
The package will intelligently decide whether to write spinners on stdout, stderr or neither, depending if a terminal is present.
Wrappers for Stdout and Stderr are provided so as not to interfere with the spinner while running.
Get It
go get github.com/dedelala/round
go-round
go install github.com/dedelala/round/go-round
go-round is a command line program that adds a spinner to almost
anything. It copies stdin to stdout. You can read go-round help for usage.
Use It
import "github.com/dedelala/round"
Make It Go
round.Go(round.Pipe)
Write Out
fmt.Fprintln(round.Stdout, "Like a record!")
fmt.Fprintln(round.Stderr, "Wahhhhh!")
Don't write directly to os.Stdout or os.Stderr while a spinner is running. There be dragons.
Make It Stop
round.Stop()
Built-In Styles!
| Style | = | Unicode Set |
|---|---|---|
Block |
█ | 2580—259F Block Elements |
Cylon |
@ | 0020—007F Basic Latin |
Hearts |
💖 | 1F300—1F5FF Miscellaneous Symbols and Pictographs |
Moon |
🌓 | 1F300—1F5FF Miscellaneous Symbols and Pictographs |
Pipe |
- | 0020—007F Basic Latin |
Make Your Own Scroller
s := round.NewScroller(12, "[%v]", "Do Not Panic!")
round.Start(s)
Documentation
¶
Overview ¶
Package round is a command line spinner. Start one with Go.
The package will intelligently decide whether to write spinners on stdout, stderr or neither, depending if a terminal is present.
Wrappers for Stdout and Stderr are provided so as not to interfere with the spinner while running.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // Stdout is a spin-safe version of os.Stdout. Stdout io.Writer // Stderr is a spin-safe version of os.Stderr. Stderr io.Writer )
var Block = Style{ []string{"▏", "▎", "▍", "▌", "▋", "▊", "▉", "█", "▇", "▆", "▅", "▄", "▃", "▂", "▁", ""}, 60 * time.Millisecond, }
Block is a good old trusty block thing. It uses "█" from 2580—259F Block Elements.
var Cylon = NewBouncer(7, "\x1b[1m(\x1b[31m%v\x1b[0;1m)\x1b[0m", "@")
Cylon is ominous. It uses "@" from 0020—007F Basic Latin.
var Hearts = Style{ []string{"💖💛💚💙💜", "💜💖💛💚💙", "💙💜💖💛💚", "💚💙💜💖💛", "💛💚💙💜💖"}, 90 * time.Millisecond, }
Hearts is clearly the best style! It uses "💜" from 1F300—1F5FF Misc Symbols and Pictographs.
var Moon = Style{[]string{"🌑", "🌒", "🌓", "🌔", "🌕", "🌖", "🌗", "🌘"}, 90 * time.Millisecond}
Moon is a series of moon phases. It uses "🌕" from 1F300—1F5FF Misc Symbols and Pictographs.
var Pipe = Style{[]string{"|", "/", "-", "\\"}, 60 * time.Millisecond}
Pipe is guaranteed to work. It uses "|" from 0020—007F Basic Latin.
Functions ¶
Types ¶
type Style ¶
Style is a spinner style. Any number of frames is allowed, each frame can be any length. The following Styles are supplied: Block, Cylon, Hearts, Moon, Pipe.
func NewBouncer ¶
NewBouncer creates a Style with some text that bounces back and forth.
func NewInvertedBouncer ¶
NewInvertedBouncer creates a Style just like NewBouncer except it goes in the opposite direction at the start. For the true pedant.
func NewInvertedScroller ¶
NewInvertedScroller creates a Style for a text scroller with the specified width and format. It scrolls from left to right.
func NewScroller ¶
NewScroller creates a Style for a text scroller with the specified width and format. It scrolls from right to left.
Source Files
Directories