The highest tagged major version is v2.

spinner

package

v0.5.1 Latest Latest Go to latest Published: Jul 30, 2020 License: MIT Imports: 3 Imported by: 1,149

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/charmbracelet/bubbles

Links

Documentation ¶

Index ¶

Variables
func Tick(m Model) tea.Cmd
func View(model Model) string
type Model
- func NewModel() Model
- func Update(msg tea.Msg, m Model) (Model, tea.Cmd)
type Spinner
type TickMsg

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// Some spinners to choose from. You could also make your own.
	Line = Spinner([]string{"|", "/", "-", "\\"})
	Dot  = Spinner([]string{"⣾ ", "⣽ ", "⣻ ", "⢿ ", "⡿ ", "⣟ ", "⣯ ", "⣷ "})
)

Functions ¶

func Tick ¶

func Tick(m Model) tea.Cmd

Tick is the command used to advance the spinner one frame.

Types ¶

type Model ¶

type Model struct {

	// Type is the set of frames to use. See Spinner.
	Frames Spinner

	// FPS is the speed at which the ticker should tick
	FPS time.Duration

	// ForegroundColor sets the background color of the spinner. It can be a
	// hex code or one of the 256 ANSI colors. If the terminal emulator can't
	// doesn't support the color specified it will automatically degrade
	// (per github.com/muesli/termenv).
	ForegroundColor string

	// BackgroundColor sets the background color of the spinner. It can be a
	// hex code or one of the 256 ANSI colors. If the terminal emulator can't
	// doesn't support the color specified it will automatically degrade
	// (per github.com/muesli/termenv).
	BackgroundColor string
	// contains filtered or unexported fields
}

Model contains the state for the spinner. Use NewModel to create new models rather than using Model as a struct literal.

func NewModel ¶

func NewModel() Model

NewModel returns a model with default values.

func Update ¶

func Update(msg tea.Msg, m Model) (Model, tea.Cmd)

Update is the Tea update function. This will advance the spinner one frame every time it's called, regardless the message passed, so be sure the logic is setup so as not to call this Update needlessly.