go_spinner

package module

v0.0.0-...-eac0e0e Latest Latest Go to latest Published: Nov 29, 2022 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/vz250049/go-spinner

Links

Open Source Insights

README ¶

go-spinner

Documentation ¶

Index ¶

Constants
Variables
type Spinner
- func NewSpinner(title string) *Spinner
- func StartNew(title string) *Spinner

Constants ¶

View Source

const (
	// 150ms per frame
	DEFAULT_FRAME_RATE = time.Millisecond * 150
)

Variables ¶

View Source

var DefaultCharset = []string{"|", "/", "-", "\\"}

Functions ¶

This section is empty.

Types ¶

type Spinner ¶

type Spinner struct {
	sync.Mutex
	Title     string
	Charset   []string
	FrameRate time.Duration

	Output io.Writer
	NoTty  bool
	// contains filtered or unexported fields
}

func NewSpinner ¶

func NewSpinner(title string) *Spinner

create spinner object

func StartNew ¶

func StartNew(title string) *Spinner

start a new spinner, title can be an empty string

func (*Spinner) SetCharset ¶

func (sp *Spinner) SetCharset(chars []string) *Spinner

set custom spinner character set

func (*Spinner) SetSpeed ¶

func (sp *Spinner) SetSpeed(rate time.Duration) *Spinner

set custom spinner frame rate

func (*Spinner) Start ¶

func (sp *Spinner) Start() *Spinner

start spinner

func (*Spinner) Stop ¶

func (sp *Spinner) Stop()

stop and clear the spinner

Source Files ¶

View all Source files

spinner1.go

Directories ¶

Path	Synopsis
_example

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL