support third party renderer

Author: lonnywong

codes.go

@@ -65,6 +65,7 @@ const (
 // The functions inside the map link the state, color and background colors strings detected in templates to a Styler
 // function that applies the given style using the corresponding constant.
 var FuncMap = template.FuncMap{
+	"default":   Styler(reset),
 	"black":     Styler(FGBlack),
 	"red":       Styler(FGRed),
 	"green":     Styler(FGGreen),

go.mod

@@ -4,5 +4,7 @@ go 1.12
 
 require (
 	github.com/chzyer/readline v1.5.1
-	golang.org/x/sys v0.10.0 // indirect
+	github.com/mattn/go-runewidth v0.0.15
+	github.com/rivo/uniseg v0.4.4 // indirect
+	golang.org/x/sys v0.16.0 // indirect
 )

go.sum

@@ -1,15 +1,14 @@
-github.com/chzyer/logex v1.1.10 h1:Swpa1K6QvQznwJRcfTfQJmTE72DqScAa40E+fbHEXEE=
-github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI=
+github.com/chzyer/logex v1.2.1 h1:XHDu3E6q+gdHgsdTPH6ImJMIp436vR6MPtH8gP05QzM=
 github.com/chzyer/logex v1.2.1/go.mod h1:JLbx6lG2kDbNRFnfkgvh4eRJRPX1QCoOIWomwysCBrQ=
-github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e h1:fY5BOSpyZCqRo5OhCuC+XN+r/bBCmeuuJtjz+bCNIf8=
-github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI=
 github.com/chzyer/readline v1.5.1 h1:upd/6fQk4src78LMRzh5vItIt361/o4uq553V8B5sGI=
 github.com/chzyer/readline v1.5.1/go.mod h1:Eh+b79XXUwfKfcPLepksvw2tcLE/Ct21YObkaSkeBlk=
-github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1 h1:q763qf9huN11kDQavWsoZXJNW3xEE4JJyHa5Q25/sd8=
-github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU=
+github.com/chzyer/test v1.0.0 h1:p3BQDXSxOhOG0P9z6/hGnII4LGiEPOYBhs8asl/fC04=
 github.com/chzyer/test v1.0.0/go.mod h1:2JlltgoNkt4TW/z9V/IzDdFaMTM2JPIi26O1pF38GC8=
-golang.org/x/sys v0.0.0-20181122145206-62eef0e2fa9b h1:MQE+LT/ABUuuvEZ+YQAMSXindAdUh7slEmAkup74op4=
-golang.org/x/sys v0.0.0-20181122145206-62eef0e2fa9b/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+github.com/mattn/go-runewidth v0.0.15 h1:UNAjwbU9l54TA3KzvqLGxwWjHmMgBUVhBiTjelZgg3U=
+github.com/mattn/go-runewidth v0.0.15/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
+github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
+github.com/rivo/uniseg v0.4.4 h1:8TfxU8dW6PdqD27gjM8MVNuicgxIjxpm4K7x4jp8sis=
+github.com/rivo/uniseg v0.4.4/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
 golang.org/x/sys v0.0.0-20220310020820-b874c991c1a5/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.10.0 h1:SqMFp9UcQJZa+pmYuAKjd9xq1f0j5rLcDIk0mj4qAsA=
-golang.org/x/sys v0.10.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.16.0 h1:xWw16ngr6ZMtmxDyKyIgsE93KNKz5HKmMa3b8ALHidU=
+golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=

screenbuf/screenbuf.go

@@ -110,6 +110,19 @@ func (s *ScreenBuf) Write(b []byte) (int, error) {
 	}
 }
 
+// WriteLines writes multiple lines to the underlining buffer.
+func (s *ScreenBuf) WriteLines(b []byte) (int, error) {
+	total := 0
+	for _, d := range bytes.Split(b, []byte("\n")) {
+		n, err := s.Write(d)
+		if err != nil {
+			return total + n, err
+		}
+		total += n
+	}
+	return total, nil
+}
+
 // Flush writes any buffered data to the underlying io.Writer, ensuring that any pending data is displayed.
 func (s *ScreenBuf) Flush() error {
 	for i := s.cursor; i < s.height; i++ {

select.go

@@ -6,7 +6,6 @@ import (
 	"io"
 	"os"
 	"strings"
-	"text/tabwriter"
 	"text/template"
 
 	"github.com/chzyer/readline"
@@ -184,6 +183,15 @@ type SelectTemplates struct {
 	// Keywords is a text/template for the search keywords.
 	Keywords string
 
+	// HideLabel sets whether to hide the label.
+	HideLabel bool
+
+	// ItemsRenderer is a custom rendering visible items function.
+	ItemsRenderer func(items []interface{}, idx int) string
+
+	// DetailsRenderer is a custom rendering active item function.
+	DetailsRenderer func(item interface{}) string
+
 	// FuncMap is a map of helper functions that can be used inside of templates according to the text/template
 	// documentation.
 	//
@@ -252,6 +260,44 @@ func (s *Select) getKeywords(keywords string) string {
 	return s.Keywords + " " + keywords
 }
 
+func (s *Select) renderItems(items []interface{}, idx int, top rune) []byte {
+	last := len(items) - 1
+
+	var buf bytes.Buffer
+	w := NewWriter(&buf, 0, 0, 2, ' ', 0)
+	for i, item := range items {
+		page := " "
+
+		switch i {
+		case 0:
+			if s.list.CanPageUp() {
+				page = "↑"
+			} else {
+				page = string(top)
+			}
+		case last:
+			if s.list.CanPageDown() {
+				page = "↓"
+			}
+		}
+
+		output := []byte(page + " ")
+
+		if i == idx {
+			output = append(output, render(s.Templates.active, item)...)
+		} else {
+			output = append(output, render(s.Templates.inactive, item)...)
+		}
+
+		w.Write(output)
+		if i != last {
+			w.Write([]byte("\n"))
+		}
+	}
+	w.Flush()
+	return buf.Bytes()
+}
+
 func (s *Select) innerRun(cursorPos, scroll int, top rune) (int, string, error) {
 	c := &readline.Config{
 		Stdin:  s.Stdin,
@@ -369,55 +415,27 @@ func (s *Select) innerRun(cursorPos, scroll int, top rune) (int, string, error)
 			sb.Write(render(s.Templates.keywords, s.Keywords))
 		}
 
-		label := render(s.Templates.label, s.Label)
-		sb.Write(label)
+		if !s.Templates.HideLabel {
+			label := render(s.Templates.label, s.Label)
+			sb.WriteLines(label)
+		}
 
 		items, idx := s.list.Items()
-		last := len(items) - 1
-
-		var buf bytes.Buffer
-		w := tabwriter.NewWriter(&buf, 0, 0, 2, ' ', 0)
-		for i, item := range items {
-			page := " "
-
-			switch i {
-			case 0:
-				if s.list.CanPageUp() {
-					page = "↑"
-				} else {
-					page = string(top)
-				}
-			case last:
-				if s.list.CanPageDown() {
-					page = "↓"
-				}
-			}
-
-			output := []byte(page + " ")
-
-			if i == idx {
-				output = append(output, render(s.Templates.active, item)...)
-			} else {
-				output = append(output, render(s.Templates.inactive, item)...)
-			}
-
-			w.Write(output)
-			w.Write([]byte("\n"))
-		}
-		w.Flush()
-		for _, d := range bytes.Split(buf.Bytes(), []byte("\n")) {
-			sb.Write(d)
+		if s.Templates.ItemsRenderer != nil {
+			sb.WriteLines([]byte(s.Templates.ItemsRenderer(items, idx)))
+		} else {
+			sb.WriteLines(s.renderItems(items, idx, top))
 		}
 
 		if idx == list.NotFound {
 			sb.WriteString("")
 			sb.WriteString("No results")
 		} else {
 			active := items[idx]
-
-			details := s.renderDetails(active)
-			for _, d := range details {
-				sb.Write(d)
+			if s.Templates.DetailsRenderer != nil {
+				sb.WriteLines([]byte(s.Templates.DetailsRenderer(active)))
+			} else {
+				sb.WriteLines(s.renderDetails(active))
 			}
 		}
 
@@ -508,22 +526,24 @@ func (s *Select) prepareTemplates() error {
 		tpls.FuncMap = FuncMap
 	}
 
-	if tpls.Label == "" {
-		tpls.Label = fmt.Sprintf("%s {{.}}: ", IconInitial)
-	}
+	if !tpls.HideLabel {
+		if tpls.Label == "" {
+			tpls.Label = fmt.Sprintf("%s {{.}}: ", IconInitial)
+		}
 
-	tpl, err := template.New("").Funcs(tpls.FuncMap).Parse(tpls.Label)
-	if err != nil {
-		return err
-	}
+		tpl, err := template.New("").Funcs(tpls.FuncMap).Parse(tpls.Label)
+		if err != nil {
+			return err
+		}
 
-	tpls.label = tpl
+		tpls.label = tpl
+	}
 
 	if tpls.Active == "" {
 		tpls.Active = fmt.Sprintf("%s {{ . | underline }}", IconSelect)
 	}
 
-	tpl, err = template.New("").Funcs(tpls.FuncMap).Parse(tpls.Active)
+	tpl, err := template.New("").Funcs(tpls.FuncMap).Parse(tpls.Active)
 	if err != nil {
 		return err
 	}
@@ -699,25 +719,22 @@ func (s *Select) setKeys() {
 	}
 }
 
-func (s *Select) renderDetails(item interface{}) [][]byte {
+func (s *Select) renderDetails(item interface{}) []byte {
 	if s.Templates.details == nil {
 		return nil
 	}
 
 	var buf bytes.Buffer
 
-	w := tabwriter.NewWriter(&buf, 0, 0, 2, ' ', 0)
+	w := NewWriter(&buf, 0, 0, 2, ' ', 0)
 
 	err := s.Templates.details.Execute(w, item)
 	if err != nil {
 		fmt.Fprintf(w, "%v", item)
 	}
 
 	w.Flush()
-
-	output := buf.Bytes()
-
-	return bytes.Split(output, []byte("\n"))
+	return buf.Bytes()
 }
 
 func (s *Select) renderHelp(b bool) []byte {