Skip to content

Various terminal busy indicators (eg. spinner, throbber, progress) for Go applications

License

Notifications You must be signed in to change notification settings

ckaznocha/busyIndicator

Repository files navigation

busyIndicator

Build Status License

This is mostly a for-fun project as an excuse to mess with some things I don't normally have a reason to use. There are other similar projects that may be more mature.

-- import "github.com/ckaznocha/busyIndicator"

Usage

var (

	//Spin is a standard spinner
	Spin = []string{"-", "\\", "|", "/"}

	//Dot is an ellipsis sequence
	Dot = []string{"", ".", "..", "..."}

	//Grow is a . that grows up to be an O
	Grow = []string{".", "ₒ", "ⱺ", "O", "ⱺ", "ₒ", "."}
)

func Progress

func Progress(
	marks ProgressMarks,
	progress chan float64,
	cancel chan bool,
)

Progress starts a progress bar

func ProgressAnimated

func ProgressAnimated(
	marks ProgressMarks,
	speed time.Duration,
	progress chan float64,
	cancel chan bool,
)

ProgressAnimated starts an animated progress bar

func Throbber

func Throbber(
	vals []string,
	speed time.Duration,
	c chan bool,
)

Throbber starts a throbber

func ThrobberPostfixed

func ThrobberPostfixed(
	postfix string,
	vals []string,
	speed time.Duration,
	c chan bool,
)

ThrobberPostfixed starts a throbber with a given static postfix

func ThrobberPrefixed

func ThrobberPrefixed(
	prefix string,
	vals []string,
	speed time.Duration,
	c chan bool,
)

ThrobberPrefixed starts a throbber with a given static prefix

func ThrobberPrefixedAndPostfixed

func ThrobberPrefixedAndPostfixed(
	prefix string,
	postfix string,
	vals []string,
	speed time.Duration,
	c chan bool,
)

ThrobberPrefixedAndPostfixed starts a throbber with a given static prefix and postfix

type ProgressMarks

type ProgressMarks struct {
	Completed  rune
	Incomplete rune
}

ProgressMarks holds the runes you'd like to use for your progress bar

About

Various terminal busy indicators (eg. spinner, throbber, progress) for Go applications

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages