feat(textinput): store and recover history

[nobe4]

This adds the history functionality to the textinput model. Specific actions can push a new value into the history and they can be switched back to via key presses.

This is done in relation to nobe4/gh-not#190 I was considering implementing that in my project, and realized that it could just be part of bubbles instead.

Looking forward to getting some feedback on this. Especially the comments below.

Example usage

package main

import (
	"github.com/charmbracelet/bubbles/textinput"
	tea "github.com/charmbracelet/bubbletea"
)

type Model struct {
	t textinput.Model
}

func (m Model) Init() tea.Cmd { return nil }
func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
	switch msg := msg.(type) {
	case tea.KeyMsg:
		switch msg.Type {
		case tea.KeyEsc:
			return m, tea.Quit

		case tea.KeyEnter:
			m.t.SaveHistory()
			return m, nil
		}
	}

	var cmd tea.Cmd
	m.t, cmd = m.t.Update(msg)
	return m, cmd
}

func (m Model) View() string {
	return m.t.View()
}

func main() {
	m := Model{
		t: textinput.New(),
	}
	m.t.Focus()

	p := tea.NewProgram(m)
	if _, err := p.Run(); err != nil {
		panic(err)
	}
}

[nobe4]

This feels suboptimal, but I didn't find any alternative solution.

[nobe4]

Up and Down feel more natural to me, as a shell/vim user than updating completion. However this might break existing applications and change the default behavior, so I'd be happy not to change it.

Which keys would you recommend?

[nobe4]

The m.getSuggestions really just transforms a [][]rune into a []string, so the name could be updated to reflect this.

[meowgorithm]

Thanks for the PR! So right off the cuff, I sort of wonder if this should be implemented externally, possibly with an interface. That would allow to, for example, store large amounts of history via sqlite, or store and fetch history over the network.

[caarlos0]

text input already have the suggestions feature, which can be used as a history.

fwiw we also have the same feature in the works for textarea.

if you don't like how suggestions work, you can also disable the keybinding and wrap textinput, setting the actual contents of the history as the value of the textinput (instead of ghost text).

[nobe4]

I sort of wonder if this should be implemented externally, possibly with an interface.

Possibly! Do you think this would be more worthwhile? If so, would the interface be a member of the TextInput model?

I like the idea of decoupling the two.

The interface could look like:

type HistoryManager interface {
  Save(string) error
  Get() (string, error)
  Next()
  Previous()
}

text input already have the suggestions feature, which can be used as a history.
if you don't like how suggestions work, [...]

It can, but if I want to use both suggestion and history, then I would be stuck :)
And they serve slightly different purpose as well, IMHO it's not good to conflate the two.

Coming from (Neo)Vim, having the completion + the history is incredibly useful to repeat command.