Implemented bubbles list widget

go.mod

@@ -5,8 +5,11 @@ go 1.13
 require (
 	github.com/atotto/clipboard v0.1.2
 	github.com/charmbracelet/bubbletea v0.12.2
+	github.com/jinzhu/copier v0.0.0-20201025035756-632e723a6687
 	github.com/mattn/go-runewidth v0.0.9
+	github.com/muesli/reflow v0.1.1-0.20200715144030-a312cb5b2d8d
 	github.com/muesli/termenv v0.7.4
 	golang.org/x/crypto v0.0.0-20201016220609-9e8e0b390897 // indirect
+	golang.org/x/sys v0.0.0-20201015000850-e3ed0017c211 // indirect
 	golang.org/x/sys v0.0.0-20201020230747-6e5568b54d1a // indirect
 )

go.sum

@@ -6,12 +6,17 @@ github.com/containerd/console v1.0.1 h1:u7SFAJyRqWcG6ogaMAx3KjSTy1e3hT9QxqX7Jco7
 github.com/containerd/console v1.0.1/go.mod h1:XUsP6YE/mKtz6bxc+I8UiKKTP04qjQL4qcS3XoQ5xkw=
 github.com/google/goterm v0.0.0-20190703233501-fc88cf888a3f h1:5CjVwnuUcp5adK4gmY6i72gpVFVnZDP2h5TmPScB6u4=
 github.com/google/goterm v0.0.0-20190703233501-fc88cf888a3f/go.mod h1:nOFQdrUlIlx6M6ODdSpBj1NVA+VgLC6kmw60mkw34H4=
+github.com/jinzhu/copier v0.0.0-20201025035756-632e723a6687 h1:bWXum+xWafUxxJpcXnystwg5m3iVpPYtrGJFc1rjfLc=
+github.com/jinzhu/copier v0.0.0-20201025035756-632e723a6687/go.mod h1:24xnZezI2Yqac9J61UC6/dG/k76ttpq0DdJI3QmUvro=
 github.com/lucasb-eyer/go-colorful v1.0.3 h1:QIbQXiugsb+q10B+MI+7DI1oQLdmnep86tWFlaaUAac=
 github.com/lucasb-eyer/go-colorful v1.0.3/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
 github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY=
 github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
+github.com/mattn/go-runewidth v0.0.7/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI=
 github.com/mattn/go-runewidth v0.0.9 h1:Lm995f3rfxdpd6TSmuVCHVb/QhupuXlYr8sCI/QdE+0=
 github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI=
+github.com/muesli/reflow v0.1.1-0.20200715144030-a312cb5b2d8d h1:ok5jhmKQze1yERN73u46EZhUH4vgC1z4qfeFJ8iOwvg=
+github.com/muesli/reflow v0.1.1-0.20200715144030-a312cb5b2d8d/go.mod h1:I9bWAt7QTg/que/qmUCJBGlj7wEq8OAFBjPNjc6xK4I=
 github.com/muesli/termenv v0.7.2 h1:r1raklL3uKE7rOvWgSenmEm2px+dnc33OTisZ8YR1fw=
 github.com/muesli/termenv v0.7.2/go.mod h1:ct2L5N2lmix82RaY3bMWwVu/jUFc9Ule0KGDCiKYPh8=
 github.com/muesli/termenv v0.7.4 h1:/pBqvU5CpkY53tU0vVn+xgs2ZTX63aH5nY+SSps5Xa8=
@@ -30,6 +35,7 @@ golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20200916030750-2334cc1a136f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20201009025420-dfb3f7c4e634 h1:bNEHhJCnrwMKNMmOx3yAynp5vs5/gRy+XWFtZFu7NBM=
 golang.org/x/sys v0.0.0-20201009025420-dfb3f7c4e634/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20201015000850-e3ed0017c211/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20201020230747-6e5568b54d1a h1:e3IU37lwO4aq3uoRKINC7JikojFmE5gO7xhfxs8VC34=
 golang.org/x/sys v0.0.0-20201020230747-6e5568b54d1a/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=

list/example/checkboxes/main.go

@@ -0,0 +1,201 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"strconv"
+
+	"github.com/charmbracelet/bubbles/list"
+	tea "github.com/charmbracelet/bubbletea"
+)
+
+// DISCLAIMER: This is not a template but a example.
+// This code is NOT performant or good for any other purpose except to show the possibility's of the list bubble.
+
+func main() {
+	m := model{}
+	m.vis = list.NewModel()
+	m.vis.PrefixGen = NewPrefixer()
+	m.head = "My TODO list!\n============="
+	m.AddItems([]string{
+		"buying eggs",
+		"take the trash out",
+		"get a hair cut",
+		"be nice\nto the neighbours",
+		"get milk",
+	})
+	m.tail = "============================================\nuse ' ' to change the done state of a item\nuse 'q' or 'ctrl+c' to exit"
+	p := tea.NewProgram(m)
+	if err := p.Start(); err != nil {
+		fmt.Println("could not run program:", err)
+		os.Exit(1)
+	}
+}
+
+type item struct {
+	selected bool
+	content  string
+	id       int
+}
+
+func (m item) String() string {
+	return m.content
+}
+
+type model struct {
+	vis   list.Model
+	jump  string
+	ready bool
+	head  string
+	tail  string
+}
+
+func (m model) Init() tea.Cmd {
+	return nil
+}
+
+// update recives messages and the model and changes the model accordingly to the messages
+func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+	if m.vis.PrefixGen == nil {
+		// use default
+		m.vis.PrefixGen = NewPrefixer()
+	}
+
+	switch msg := msg.(type) {
+	case tea.KeyMsg:
+
+		// Ctrl+c exits
+		if msg.Type == tea.KeyCtrlC {
+			return m, tea.Quit
+		}
+		keyString := msg.String()
+		switch keyString {
+		case "q":
+			return m, tea.Quit
+		case "1", "2", "3", "4", "5", "6", "7", "8", "9", "0":
+			m.jump += keyString
+			return m, nil
+		case "down", "j":
+			m.vis.MoveCursor(m.popJump(1))
+			return m, nil
+		case "up", "k":
+			m.vis.MoveCursor(-m.popJump(1))
+			return m, nil
+		case "r":
+			d, ok := m.vis.PrefixGen.(*SelectPrefixer)
+			if ok {
+				d.NumberRelative = !d.NumberRelative
+			}
+			return m, nil
+		case "J":
+			m.vis.MoveItem(m.popJump(1))
+			return m, nil
+		case "K":
+			m.vis.MoveItem(-m.popJump(1))
+			return m, nil
+		case "t", "home":
+			j := m.popJump(0)
+			if j > 0 {
+				j--
+			}
+			m.vis.Top()
+			m.vis.MoveCursor(j)
+			return m, nil
+		case "b", "end":
+			j := m.popJump(0)
+			if j > 0 {
+				j--
+			}
+			m.vis.Bottom()
+			m.vis.MoveCursor(-j)
+			return m, nil
+		case "w":
+			m.vis.Wrap = m.popJump(0)
+			return m, nil
+		case "s":
+			less := func(a, b fmt.Stringer) bool { return a.String() < b.String() }
+			m.vis.SetLess(less)
+			m.vis.Sort()
+			return m, nil
+		case "o":
+			less := func(a, b fmt.Stringer) bool {
+				d, _ := a.(item)
+				e, _ := b.(item)
+				return d.id < e.id
+			}
+			m.vis.SetLess(less)
+			m.vis.Sort()
+			return m, nil
+		case " ":
+			updater := func(a fmt.Stringer) (fmt.Stringer, tea.Cmd) {
+				i, ok := a.(item)
+				if !ok {
+					return a, nil
+				}
+				i.selected = !i.selected
+				return i, nil
+			}
+			i, _ := m.vis.GetCursorIndex()
+			cmd := m.vis.UpdateItem(i, updater)
+			return m, cmd
+		default:
+			// resets jump buffer to prevent confusion
+			m.jump = ""
+
+			// pipe all other commands to the update from the vis
+			l, newMsg := m.vis.Update(msg)
+			vis, _ := l.(list.Model)
+			m.vis = vis
+			return m, newMsg
+		}
+
+	case tea.WindowSizeMsg:
+
+		width := msg.Width
+		height := msg.Height
+		m.vis.Screen.Width = width
+		m.vis.Screen.Height = height
+
+		if !m.ready {
+			// Since this program can use the full size of the viewport we need
+			// to wait until we've received the window dimensions before we
+			// can initialize the viewport. The initial dimensions come in
+			// quickly, though asynchronously, which is why we wait for them
+			// here.
+			m.ready = true
+		}
+		return m, nil
+
+	default:
+		// pipe all other commands to the update from the vis
+		l, newMsg := m.vis.Update(msg)
+		vis, _ := l.(list.Model)
+		m.vis = vis
+		return m, newMsg
+	}
+}
+
+func (m model) View() string {
+	return fmt.Sprintf("%s\n%s\n%s", m.head, m.vis.View(), m.tail)
+}
+func (m *model) AddItems(toAdd []string) {
+	strList := make([]fmt.Stringer, len(toAdd))
+	for i, str := range toAdd {
+		strList[i] = item{content: str}
+	}
+	m.vis.AddItems(strList)
+}
+
+// popJump takes default vaule and returns the integer value of the jump string
+// if its empty or fails the default is returned.
+func (m *model) popJump(dft int) int {
+	if m.jump == "" {
+		return dft
+	}
+	j, err := strconv.Atoi(m.jump)
+	if err != nil {
+		return dft
+	}
+	m.jump = ""
+	return j
+}