bubbles/spinner/spinner.go

100 lines
2.5 KiB
Go
Raw Normal View History

2020-02-10 19:40:52 +03:00
package spinner
import (
"time"
tea "github.com/charmbracelet/bubbletea"
2020-03-27 21:10:09 +03:00
"github.com/muesli/termenv"
2020-02-10 19:40:52 +03:00
)
const (
defaultFPS = time.Second / 10
)
// Spinner is a set of frames used in animating the spinner.
type Spinner = []string
2020-02-10 19:40:52 +03:00
var (
// Some spinners to choose from. You could also make your own.
Line = Spinner([]string{"|", "/", "-", "\\"})
Dot = Spinner([]string{"⣾ ", "⣽ ", "⣻ ", "⢿ ", "⡿ ", "⣟ ", "⣯ ", "⣷ "})
2020-02-10 19:51:08 +03:00
2020-03-27 21:10:09 +03:00
color = termenv.ColorProfile().Color
2020-02-10 19:40:52 +03:00
)
// Model contains the state for the spinner. Use NewModel to create new models
// rather than using Model as a struct literal.
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).
2020-03-27 21:10:09 +03:00
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).
2020-03-27 21:10:09 +03:00
BackgroundColor string
2020-02-10 19:40:52 +03:00
frame int
}
// NewModel returns a model with default values.
2020-02-10 19:40:52 +03:00
func NewModel() Model {
return Model{
Frames: Line,
FPS: defaultFPS,
2020-02-10 19:40:52 +03:00
}
}
// TickMsg indicates that the timer has ticked and we should render a frame.
type TickMsg struct{}
2020-02-10 19:40:52 +03:00
// 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.
2020-02-10 19:40:52 +03:00
func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
if _, ok := msg.(TickMsg); ok {
m.frame++
if m.frame >= len(m.Frames) {
m.frame = 0
}
return m, Tick(m)
2020-02-10 19:40:52 +03:00
}
return m, nil
2020-02-10 19:40:52 +03:00
}
// View renders the model's view.
2020-02-10 19:40:52 +03:00
func View(model Model) string {
if model.frame >= len(model.Frames) {
return "error"
2020-02-10 19:40:52 +03:00
}
2020-03-27 21:10:09 +03:00
frame := model.Frames[model.frame]
2020-03-27 21:10:09 +03:00
if model.ForegroundColor != "" || model.BackgroundColor != "" {
return termenv.
String(frame).
2020-03-27 21:10:09 +03:00
Foreground(color(model.ForegroundColor)).
Background(color(model.BackgroundColor)).
String()
}
return frame
2020-02-10 19:40:52 +03:00
}
// Tick is the command used to advance the spinner one frame.
func Tick(m Model) tea.Cmd {
return tea.Tick(m.FPS, func(time.Time) tea.Msg {
return TickMsg{}
})
2020-02-10 19:40:52 +03:00
}