Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mdw-go/spin
Another simple console terminal spinner.
https://github.com/mdw-go/spin
Last synced: 14 days ago
JSON representation
Another simple console terminal spinner.
- Host: GitHub
- URL: https://github.com/mdw-go/spin
- Owner: mdw-go
- License: other
- Created: 2014-12-20T07:08:00.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2024-10-19T15:55:00.000Z (30 days ago)
- Last Synced: 2024-10-20T14:53:50.321Z (29 days ago)
- Language: Go
- Size: 14.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# spin
--
import "github.com/mdw-go/spin"
Package spin implements a simple console spinner. See the tests and examples for
examples.
## Usage
```go
var (
// StyleLine is a simple example of the kinds of styles you could pass into the New... functions.
StyleLine = []string{"|", "/", "-", "\\"}
// StyleSteps is another example of the kinds of styles you could pass into the New... functions.
StyleSteps = []string{"▁", "▃", "▄", "▅", "▆", "▇", "█", "▇", "▆", "▅", "▄", "▃"}
// StyleShutter is another example of the kinds of styles you could pass into the New... functions.
StyleShutter = []string{"▉", "▊", "▋", "▌", "▍", "▎", "▏", "▎", "▍", "▌", "▋", "▊", "▉"}
)
```
#### func GoStart
```go
func GoStart()
```
GoStart forwards to a package-level *Spinner (for convenience).
#### func Start
```go
func Start()
```
Start forwards to a package-level *Spinner (for convenience).
#### func Stop
```go
func Stop()
```
Stop forwards to a package-level *Spinner (for convenience).
#### type Spinner
```go
type Spinner struct {
}
```
Spinner prints a repeating pattern to os.Stdout by printing a sequence of
characters interspersed with carriage returns. A Spinner is controlled by the
provided methods: Start, GoStart (like calling `go Start()`, and Stop.
#### func New
```go
func New(style []string, delay time.Duration) *Spinner
```
New creates a spinner which you can start and stop.
#### func NewWithPadding
```go
func NewWithPadding(style []string, delay time.Duration, prefix, suffix string) *Spinner
```
NewWithPadding creates a spinner which you can start and stop. Allows a prefix
and suffix to be printed along with the specified style.
#### func (*Spinner) GoStart
```go
func (self *Spinner) GoStart()
```
GoStart begins the spinner on a fresh goroutine.
#### func (*Spinner) Start
```go
func (self *Spinner) Start()
```
Start begins the spinner on the current goroutine (hopefully you've got another
goroutine that can call Stop...).
#### func (*Spinner) Stop
```go
func (self *Spinner) Stop()
```
Stop sends a signal to stop the spinner.