chore: update to v2-exp and address comments

Author: dlvhdr

Taskfile.yaml

@@ -1,6 +1,6 @@
 # https://taskfile.dev
 
-version: '3'
+version: "3"
 
 tasks:
   lint:
@@ -17,3 +17,8 @@ tasks:
     desc: Run table tests
     cmds:
       - go test ./table {{.CLI_ARGS}}
+
+  test:tree:
+    desc: Run tree tests
+    cmds:
+      - go test ./tree {{.CLI_ARGS}}

examples/tree/selection/main.go

@@ -4,8 +4,8 @@ import (
 	"fmt"
 	"path"
 
-	"github.com/charmbracelet/lipgloss"
-	"github.com/charmbracelet/lipgloss/tree"
+	"github.com/charmbracelet/lipgloss/v2"
+	"github.com/charmbracelet/lipgloss/v2/tree"
 )
 
 const selected = "/Users/bash/.config/doom-emacs"
@@ -21,8 +21,7 @@ type styles struct {
 
 func defaultStyles() styles {
 	var s styles
-	s.base = lipgloss.NewStyle().
-		Background(lipgloss.Color("235"))
+	s.base = lipgloss.NewStyle()
 	s.container = s.base.
 		Margin(1, 2).
 		Padding(1, 0)
@@ -77,6 +76,14 @@ func (s file) Value() string {
 	return s.String()
 }
 
+func (s file) SetValue(val any) {
+	return
+}
+
+func (s file) SetHidden(val bool) {
+	return
+}
+
 func isItemSelected(children tree.Children, index int) bool {
 	child := children.At(index)
 	if file, ok := child.(file); ok && file.name == selected {

examples/tree/styles/main.go

@@ -1,6 +1,8 @@
 package main
 
 import (
+	"fmt"
+
 	"github.com/charmbracelet/lipgloss/v2"
 	"github.com/charmbracelet/lipgloss/v2/tree"
 )

list/list.go

@@ -147,6 +147,36 @@ func (l *List) EnumeratorStyleFunc(f StyleFunc) *List {
 	return l
 }
 
+// IndenterStyle sets the enumerator style for all enumerators.
+//
+// To set the enumerator style conditionally based on the item value or index,
+// use [IndenterStyleFunc].
+func (l *List) IndenterStyle(style lipgloss.Style) *List {
+	l.tree.IndenterStyle(style)
+	return l
+}
+
+// IndenterStyleFunc sets the enumerator style function for the list items.
+//
+// Use this to conditionally set different styles based on the current items,
+// sibling items, or index values (i.e. even or odd).
+//
+// Example:
+//
+//	l := list.New().
+//		IndenterStyleFunc(func(_ list.Items, i int) lipgloss.Style {
+//			if selected == i {
+//				return lipgloss.NewStyle().Foreground(brightPink)
+//			}
+//			return lipgloss.NewStyle()
+//		})
+func (l *List) IndenterStyleFunc(f StyleFunc) *List {
+	l.tree.IndenterStyleFunc(func(children tree.Children, index int) lipgloss.Style {
+		return f(children, index)
+	})
+	return l
+}
+
 // Indenter sets the indenter implementation. This is used to change the way
 // the tree is indented. The default indentor places a border connecting sibling
 // elements and no border for the last child.

list/list_test.go

@@ -6,10 +6,11 @@ import (
 	"unicode"
 
 	"github.com/aymanbagabas/go-udiff"
+	"github.com/charmbracelet/x/exp/golden"
+
 	"github.com/charmbracelet/lipgloss/v2"
 	"github.com/charmbracelet/lipgloss/v2/list"
 	"github.com/charmbracelet/lipgloss/v2/tree"
-	"github.com/charmbracelet/x/exp/golden"
 )
 
 // XXX: can't write multi-line examples if the underlying string uses
@@ -79,11 +80,13 @@ func TestComplexSublist(t *testing.T) {
 		Item(
 			list.New().
 				EnumeratorStyle(style2).
+				IndenterStyle(style2).
 				Enumerator(list.Alphabet).
 				Item("foo").
 				Item("Deeper").
 				Item(
 					list.New().
+						IndenterStyle(style1).
 						EnumeratorStyle(style1).
 						Enumerator(list.Arabic).
 						Item("a").
@@ -92,13 +95,15 @@ func TestComplexSublist(t *testing.T) {
 						Item(
 							list.New().
 								Enumerator(list.Asterisk).
+								IndenterStyle(style2).
 								EnumeratorStyle(style2).
 								Item("sus").
 								Item("d minor").
 								Item("f#").
 								Item("One ore level, with another renderer").
 								Item(
 									list.New().
+										IndenterStyle(style1).
 										EnumeratorStyle(style1).
 										Enumerator(list.Dash).
 										Item("a\nmultine\nstring").
@@ -108,12 +113,14 @@ func TestComplexSublist(t *testing.T) {
 										Item(
 
 											tree.New().
+												IndenterStyle(style2).
 												EnumeratorStyle(style2).
 												Child("another\nmultine\nstring").
 												Child("something").
 												Child("a subtree").
 												Child(
 													tree.New().
+														IndenterStyle(style2).
 														EnumeratorStyle(style2).
 														Child("yup").
 														Child("many itens").

tree/renderer.go

@@ -25,7 +25,7 @@ func newRenderer() *renderer {
 				return lipgloss.NewStyle().PaddingRight(1)
 			},
 			indenterFunc: func(Children, int) lipgloss.Style {
-				return lipgloss.NewStyle()
+				return lipgloss.NewStyle().PaddingRight(1)
 			},
 			itemFunc: func(Children, int) lipgloss.Style {
 				return lipgloss.NewStyle()
@@ -81,20 +81,22 @@ func (r *renderer) render(node Node, root bool, prefix string) string {
 		}
 		indentStyle := r.style.indenterFunc(children, i)
 		enumStyle := r.style.enumeratorFunc(children, i)
+
 		itemStyle := r.style.itemFunc(children, i)
 
-		indent := indenter(children, i)
-		nodeIndent := indentStyle.Render(indent)
+		indent := indentStyle.Render(indenter(children, i))
 		nodePrefix := enumStyle.Render(enumerator(children, i))
+
+		// Preserve the background color of the enumerator when adding the padding
+		enumBgStyle := lipgloss.NewStyle().Background(enumStyle.GetBackground())
+
+		// Add padding to the left of the node to align it with the longest prefix of its siblings
 		if l := maxLen - lipgloss.Width(nodePrefix); l > 0 {
-			nodePrefix = enumStyle.Render(strings.Repeat(" ", l)) + nodePrefix
+			nodePrefix = enumBgStyle.Render(strings.Repeat(" ", l)) + nodePrefix
 		}
 
 		item := itemStyle.Render(child.Value())
-		multineLinePrefix := prefix
-		if multineLinePrefix != "" {
-			multineLinePrefix = indentStyle.Render(multineLinePrefix)
-		}
+		multineLinePrefix := enumBgStyle.Render(prefix)
 
 		// This dance below is to account for multiline prefixes, e.g. "|\n|".
 		// In that case, we need to make sure that both the parent prefix and
@@ -103,14 +105,14 @@ func (r *renderer) render(node Node, root bool, prefix string) string {
 			nodePrefix = lipgloss.JoinVertical(
 				lipgloss.Left,
 				nodePrefix,
-				nodeIndent,
+				indent,
 			)
 		}
 		for lipgloss.Height(nodePrefix) > lipgloss.Height(multineLinePrefix) {
 			multineLinePrefix = lipgloss.JoinVertical(
 				lipgloss.Left,
 				multineLinePrefix,
-				indentStyle.Render(prefix),
+				prefix,
 			)
 		}
 

tree/tree_test.go

@@ -3,12 +3,13 @@ package tree_test
 import (
 	"testing"
 
+	"github.com/charmbracelet/x/ansi"
+	"github.com/charmbracelet/x/exp/golden"
+
 	"github.com/charmbracelet/lipgloss/v2"
 	"github.com/charmbracelet/lipgloss/v2/list"
 	"github.com/charmbracelet/lipgloss/v2/table"
 	"github.com/charmbracelet/lipgloss/v2/tree"
-	"github.com/charmbracelet/x/ansi"
-	"github.com/charmbracelet/x/exp/golden"
 )
 
 func TestTree(t *testing.T) {
@@ -182,6 +183,9 @@ func TestTreeCustom(t *testing.T) {
 		EnumeratorStyle(lipgloss.NewStyle().
 			Foreground(lipgloss.Color("12")).
 			PaddingRight(1)).
+		IndenterStyle(lipgloss.NewStyle().
+			Foreground(lipgloss.Color("12")).
+			PaddingRight(1)).
 		Enumerator(func(tree.Children, int) string {
 			return "->"
 		}).