Make Viewport more idomatic BubbleTea (per v0.12.x)

README.md

@@ -36,11 +36,6 @@ the common, and many customization options.
 * [Example code, many fields](https://github.com/charmbracelet/tea/tree/master/examples/textinputs/main.go)
 
 
-## Button
-
-A button component.
-
-
 ## Paginator
 
 <img src="https://stuff.charm.sh/bubbles-examples/pagination.gif" width="200" alt="Paginator Example">

button/button.go

@@ -1,90 +0,0 @@
-package button
-
-import (
-	tea "github.com/charmbracelet/bubbletea"
-	"github.com/muesli/termenv"
-)
-
-var (
-	// color is a helper for returning colors.
-	color func(s string) termenv.Color = termenv.ColorProfile().Color
-)
-
-// Model is the Bubble Tea model for a button element.
-type Model struct {
-	Err error
-
-	Label   string
-	Default bool
-
-	TextColor              string
-	BackgroundColor        string
-	FocusedTextColor       string
-	FocusedBackgroundColor string
-
-	// Focus indicates whether user focus should be on this button component
-	focus bool
-}
-
-// NewModel creates a new model with default settings.
-func NewModel() Model {
-	return Model{
-		Label: "Button",
-	}
-}
-
-// Update is the Tea update loop.
-func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
-	if !m.focus {
-		return m, nil
-	}
-
-	switch msg := msg.(type) {
-	case tea.KeyMsg:
-		switch msg.String() {
-		case "enter":
-			// TODO: implement
-		}
-	}
-
-	return m, nil
-}
-
-// View renders the button in its current state.
-func (m Model) View() string {
-	margin := m.styled("  ").String()
-	label := m.styled(m.Label)
-	if m.Default {
-		label = label.Underline()
-	}
-
-	return margin + label.String() + margin
-}
-
-// Focused returns the focus state on the model.
-func (m Model) Focused() bool {
-	return m.focus
-}
-
-// Focus sets the focus state on the model.
-func (m *Model) Focus() {
-	m.focus = true
-}
-
-// Blur removes the focus state on the model.
-func (m *Model) Blur() {
-	m.focus = false
-}
-
-func (m Model) styled(s string) termenv.Style {
-	view := termenv.String(s)
-	if m.focus {
-		view = view.Foreground(color(m.FocusedTextColor)).
-			Background(color(m.FocusedBackgroundColor))
-	} else {
-		view = view.Foreground(color(m.TextColor)).
-			Background(color(m.BackgroundColor))
-	}
-
-	return view
-}

go.mod

@@ -4,7 +4,7 @@ go 1.13
 
 require (
 	github.com/atotto/clipboard v0.1.2
-	github.com/charmbracelet/bubbletea v0.12.1
+	github.com/charmbracelet/bubbletea v0.12.2
 	github.com/mattn/go-runewidth v0.0.9
 	github.com/muesli/termenv v0.7.4
 	golang.org/x/crypto v0.0.0-20201016220609-9e8e0b390897 // indirect

go.sum

@@ -1,7 +1,7 @@
 github.com/atotto/clipboard v0.1.2 h1:YZCtFu5Ie8qX2VmVTBnrqLSiU9XOWwqNRmdT3gIQzbY=
 github.com/atotto/clipboard v0.1.2/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI=
-github.com/charmbracelet/bubbletea v0.12.1 h1:t21pkG2IDBRduPbt2J64Dx5yt8yIidAkXwhhrc11SzY=
-github.com/charmbracelet/bubbletea v0.12.1/go.mod h1:3gZkYELUOiEUOp0bTInkxguucy/xRbGSOcbMs1geLxg=
+github.com/charmbracelet/bubbletea v0.12.2 h1:y9Yo2Pv8tcm3mAJsWONGsmHhzrbNxJVxpVtemikxE9A=
+github.com/charmbracelet/bubbletea v0.12.2/go.mod h1:3gZkYELUOiEUOp0bTInkxguucy/xRbGSOcbMs1geLxg=
 github.com/containerd/console v1.0.1 h1:u7SFAJyRqWcG6ogaMAx3KjSTy1e3hT9QxqX7Jco7dRc=
 github.com/containerd/console v1.0.1/go.mod h1:XUsP6YE/mKtz6bxc+I8UiKKTP04qjQL4qcS3XoQ5xkw=
 github.com/google/goterm v0.0.0-20190703233501-fc88cf888a3f h1:5CjVwnuUcp5adK4gmY6i72gpVFVnZDP2h5TmPScB6u4=

paginator/paginator.go

@@ -19,7 +19,7 @@ const (
 	Dots
 )
 
-// Model is the Tea model for this user interface.
+// Model is the Bubble Tea model for this user interface.
 type Model struct {
 	Type              Type
 	Page              int
@@ -115,7 +115,7 @@ func NewModel() Model {
 }
 
 // Update is the Tea update function which binds keystrokes to pagination.
-func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
+func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
 	switch msg := msg.(type) {
 	case tea.KeyMsg:
 		if m.UsePgUpPgDownKeys {
@@ -164,16 +164,16 @@ func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
 }
 
 // View renders the pagination to a string.
-func View(m Model) string {
+func (m Model) View() string {
 	switch m.Type {
 	case Dots:
-		return dotsView(m)
+		return m.dotsView()
 	default:
-		return arabicView(m)
+		return m.arabicView()
 	}
 }
 
-func dotsView(m Model) string {
+func (m Model) dotsView() string {
 	var s string
 	for i := 0; i < m.TotalPages; i++ {
 		if i == m.Page {
@@ -185,7 +185,7 @@ func dotsView(m Model) string {
 	return s
 }
 
-func arabicView(m Model) string {
+func (m Model) arabicView() string {
 	return fmt.Sprintf(m.ArabicFormat, m.Page+1, m.TotalPages)
 }
 

spinner/spinner.go

@@ -7,17 +7,36 @@ import (
 	"github.com/muesli/termenv"
 )
 
-const (
-	defaultFPS = time.Second / 10
-)
+const defaultFPS = time.Second / 10
 
 // Spinner is a set of frames used in animating the spinner.
 type Spinner = []string
 
 var (
 	// Some spinners to choose from. You could also make your own.
-	Line = Spinner([]string{"|", "/", "-", "\\"})
-	Dot  = Spinner([]string{"⣾ ", "⣽ ", "⣻ ", "⢿ ", "⡿ ", "⣟ ", "⣯ ", "⣷ "})
+	Line   = Spinner{"|", "/", "-", "\\"}
+	Dot    = Spinner{"⣾ ", "⣽ ", "⣻ ", "⢿ ", "⡿ ", "⣟ ", "⣯ ", "⣷ "}
+	Globe  = Spinner{"🌍 ", "🌎 ", "🌏 "}
+	Moon   = Spinner{"🌑 ", "🌒 ", "🌓 ", "🌔 ", "🌕 ", "🌖 ", "🌗 ", "🌘 "}
+	Monkey = Spinner{"🙈 ", "🙈 ", "🙉 ", "🙊 "}
+	Jump   = Spinner{"⢄", "⢂", "⢁", "⡁", "⡈", "⡐", "⡠"}
+	Bit8   = Spinner{
+		"⠀", "⠁", "⠂", "⠃", "⠄", "⠅", "⠆", "⠇", "⡀", "⡁", "⡂", "⡃", "⡄", "⡅", "⡆", "⡇",
+		"⠈", "⠉", "⠊", "⠋", "⠌", "⠍", "⠎", "⠏", "⡈", "⡉", "⡊", "⡋", "⡌", "⡍", "⡎", "⡏",
+		"⠐", "⠑", "⠒", "⠓", "⠔", "⠕", "⠖", "⠗", "⡐", "⡑", "⡒", "⡓", "⡔", "⡕", "⡖", "⡗",
+		"⠘", "⠙", "⠚", "⠛", "⠜", "⠝", "⠞", "⠟", "⡘", "⡙", "⡚", "⡛", "⡜", "⡝", "⡞", "⡟",
+		"⠠", "⠡", "⠢", "⠣", "⠤", "⠥", "⠦", "⠧", "⡠", "⡡", "⡢", "⡣", "⡤", "⡥", "⡦", "⡧",
+		"⠨", "⠩", "⠪", "⠫", "⠬", "⠭", "⠮", "⠯", "⡨", "⡩", "⡪", "⡫", "⡬", "⡭", "⡮", "⡯",
+		"⠰", "⠱", "⠲", "⠳", "⠴", "⠵", "⠶", "⠷", "⡰", "⡱", "⡲", "⡳", "⡴", "⡵", "⡶", "⡷",
+		"⠸", "⠹", "⠺", "⠻", "⠼", "⠽", "⠾", "⠿", "⡸", "⡹", "⡺", "⡻", "⡼", "⡽", "⡾", "⡿",
+		"⢀", "⢁", "⢂", "⢃", "⢄", "⢅", "⢆", "⢇", "⣀", "⣁", "⣂", "⣃", "⣄", "⣅", "⣆", "⣇",
+		"⢈", "⢉", "⢊", "⢋", "⢌", "⢍", "⢎", "⢏", "⣈", "⣉", "⣊", "⣋", "⣌", "⣍", "⣎", "⣏",
+		"⢐", "⢑", "⢒", "⢓", "⢔", "⢕", "⢖", "⢗", "⣐", "⣑", "⣒", "⣓", "⣔", "⣕", "⣖", "⣗",
+		"⢘", "⢙", "⢚", "⢛", "⢜", "⢝", "⢞", "⢟", "⣘", "⣙", "⣚", "⣛", "⣜", "⣝", "⣞", "⣟",
+		"⢠", "⢡", "⢢", "⢣", "⢤", "⢥", "⢦", "⢧", "⣠", "⣡", "⣢", "⣣", "⣤", "⣥", "⣦", "⣧",
+		"⢨", "⢩", "⢪", "⢫", "⢬", "⢭", "⢮", "⢯", "⣨", "⣩", "⣪", "⣫", "⣬", "⣭", "⣮", "⣯",
+		"⢰", "⢱", "⢲", "⢳", "⢴", "⢵", "⢶", "⢷", "⣰", "⣱", "⣲", "⣳", "⣴", "⣵", "⣶", "⣷",
+		"⢸", "⢹", "⢺", "⢻", "⢼", "⢽", "⢾", "⢿", "⣸", "⣹", "⣺", "⣻", "⣼", "⣽", "⣾", "⣿"}
 
 	color = termenv.ColorProfile().Color
 )
@@ -129,33 +148,39 @@ type TickMsg struct {
 	Time time.Time
 }
 
+type startTick struct{}
+
 // 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.
-func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
-	if _, ok := msg.(TickMsg); ok {
+func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
+	switch msg.(type) {
+	case startTick:
+		return m, m.tick()
+	case TickMsg:
 		m.frame++
 		if m.frame >= len(m.Frames) {
 			m.frame = 0
 		}
-		return m, Tick(m)
+		return m, m.tick()
+	default:
+		return m, nil
 	}
-	return m, nil
 }
 
 // View renders the model's view.
-func View(model Model) string {
-	if model.frame >= len(model.Frames) {
+func (m Model) View() string {
+	if m.frame >= len(m.Frames) {
 		return "error"
 	}
 
-	frame := model.Frames[model.frame]
+	frame := m.Frames[m.frame]
 
-	if model.ForegroundColor != "" || model.BackgroundColor != "" {
+	if m.ForegroundColor != "" || m.BackgroundColor != "" {
 		return termenv.
 			String(frame).
-			Foreground(color(model.ForegroundColor)).
-			Background(color(model.BackgroundColor)).
+			Foreground(color(m.ForegroundColor)).
+			Background(color(m.BackgroundColor)).
 			String()
 	}
 
@@ -163,7 +188,11 @@ func View(model Model) string {
 }
 
 // Tick is the command used to advance the spinner one frame.
-func Tick(m Model) tea.Cmd {
+func Tick() tea.Msg {
+	return startTick{}
+}
+
+func (m Model) tick() tea.Cmd {
 	return tea.Tick(m.FPS, func(t time.Time) tea.Msg {
 		return TickMsg{
 			Time: t,

textinput/textinput.go

@@ -508,17 +508,17 @@ func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
 			m.offset = 0
 		case tea.KeyCtrlV: // ^V paste
 			return m, Paste
-		case tea.KeyRune: // input a regular character
-			if msg.Alt {
-				if msg.Rune == 'd' { // alt+d, delete word right of cursor
+		case tea.KeyRunes: // input regular characters
+			if msg.Alt && len(msg.Runes) == 1 {
+				if msg.Runes[0] == 'd' { // alt+d, delete word right of cursor
 					resetBlink = m.deleteWordRight()
 					break
 				}
-				if msg.Rune == 'b' { // alt+b, back one word
+				if msg.Runes[0] == 'b' { // alt+b, back one word
 					resetBlink = m.wordLeft()
 					break
 				}
-				if msg.Rune == 'f' { // alt+f, forward one word
+				if msg.Runes[0] == 'f' { // alt+f, forward one word
 					resetBlink = m.wordRight()
 					break
 				}
@@ -526,8 +526,8 @@ func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
 
 			// Input a regular character
 			if m.CharLimit <= 0 || len(m.value) < m.CharLimit {
-				m.value = append(m.value[:m.pos], append([]rune{msg.Rune}, m.value[m.pos:]...)...)
-				resetBlink = m.SetCursor(m.pos + 1)
+				m.value = append(m.value[:m.pos], append(msg.Runes, m.value[m.pos:]...)...)
+				resetBlink = m.SetCursor(m.pos + len(msg.Runes))
 			}
 		}
 

viewport/viewport.go

@@ -7,9 +7,7 @@ import (
 	tea "github.com/charmbracelet/bubbletea"
 )
 
-const (
-	spacebar = " "
-)
+const spacebar = " "
 
 // MODEL
 
@@ -269,7 +267,7 @@ func ViewDown(m Model, lines []string) tea.Cmd {
 }
 
 // ViewUp is a high performance command the moves the viewport down by a given
-// number of lines height. Use Model.ViewDown to get the lines that should be
+// number of lines height. Use Model.ViewUp to get the lines that should be
 // rendered.
 func ViewUp(m Model, lines []string) tea.Cmd {
 	if len(lines) == 0 {
@@ -283,7 +281,7 @@ func ViewUp(m Model, lines []string) tea.Cmd {
 // Update runs the update loop with default keybindings similar to popular
 // pagers. To define your own keybindings use the methods on Model (i.e.
 // Model.LineDown()) and define your own update function.
-func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
+func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
 	var cmd tea.Cmd
 
 	switch msg := msg.(type) {
@@ -354,7 +352,7 @@ func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
 // VIEW
 
 // View renders the viewport into a string.
-func View(m Model) string {
+func (m Model) View() string {
 	if m.HighPerformanceRendering {
 		// Just send newlines since we're doing to be rendering the actual
 		// content seprately. We still need send something that equals the