.github/CODEOWNERS

@@ -1 +1 @@
-*  @meowgorithm @muesli
+*  @meowgorithm @aymanbagabas

.github/workflows/build.yml

@@ -4,7 +4,7 @@ jobs:
   test:
     strategy:
       matrix:
-        go-version: [~1.18, ^1]
+        go-version: [~1.19, ^1]
         os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     env:
@@ -24,6 +24,12 @@ jobs:
       - name: Build
         run: go build -v ./...
 
+      - name: Build examples
+        run: |
+          go mod tidy
+          go build -v ./...
+        working-directory: ./examples
+
       - name: Test
         run: go test ./...
 

README.md

@@ -455,6 +455,206 @@ fmt.Println(t)
 
 For more on tables see [the docs](https://pkg.go.dev/github.com/charmbracelet/lipgloss?tab=doc) and [examples](https://github.com/charmbracelet/lipgloss/tree/master/examples/table).
 
+## Rendering Trees
+
+Lip Gloss ships with a tree rendering sub-package.
+
+```go
+import "github.com/charmbracelet/lipgloss/tree"
+```
+
+Define a new tree.
+
+```go
+t := tree.New("root", "child 1", "child 2", tree.New("child 3", "child 3.1"))
+```
+
+Print the tree.
+
+```go
+fmt.Println(t)
+
+// root
+// ├── child 1
+// ├── child 2
+// └── child 3
+//     └── child 3.1
+```
+
+### Customization
+
+Trees can be customized via their enumeration function as well as using
+`lipgloss.Style`s.
+
+```go
+style1 := lipgloss.NewStyle().Foreground(lipgloss.Color("99")).MarginRight(1)
+style2 := lipgloss.NewStyle().Foreground(lipgloss.Color("10")).MarginRight(1)
+
+t := tree.New().
+	Items(
+		"Glossier",
+		"Claire’s Boutique",
+		tree.New().
+			Root("Nyx").
+			Items("Qux", "Quux").
+			EnumeratorStyle(style2),
+		"Mac",
+		"Milk",
+	).
+	EnumeratorStyle(style1)
+```
+
+Print the tree:
+
+<p align="center">
+  <img
+    width="600"
+    alt="Tree example"
+    src="https://github.com/charmbracelet/lipgloss/assets/245435/5a875269-f6d6-43fa-9916-5d8360e66964"
+  />
+</p>
+You may also define custom enumerator implementations:
+
+```go
+t := tree.New().
+	Items(
+		"Glossier",
+		"Claire’s Boutique",
+		tree.New().
+			Root("Nyx").
+			Items(
+				"Qux",
+				"Quux",
+			),
+		"Mac",
+		"Milk",
+	).
+	Enumerator(func(tree.Data, int) (string, string) {
+		return "->", "->"
+	})
+```
+
+Print the tree.
+
+<p align="center">
+  <img
+    width="600"
+    alt="Tree example"
+    src="https://github.com/charmbracelet/lipgloss/assets/245435/811e8b39-124f-48bb-b3dd-e015a65b1065"
+  />
+</p>
+
+### Building
+
+If you need, you can also build trees incrementally:
+
+```go
+t := tree.New("")
+
+for i := 0; i < repeat; i++ {
+	t.Item("Lip Gloss")
+}
+```
+
+
+## Rendering Lists
+
+Lip Gloss ships with a list rendering sub-package.
+Implementation-wise, lists are still trees.
+The `list` package provides many common `Enumerator` implementations, as well as
+some syntactic sugar.
+
+```go
+import "github.com/charmbracelet/lipgloss/list"
+```
+
+Define a new list.
+
+```go
+l := list.New("A", "B", "C")
+```
+
+Print the list.
+
+```go
+fmt.Println(l)
+
+// • A
+// • B
+// • C
+```
+
+
+### Customization
+
+Lists can be customized via their enumeration function as well as using
+`lipgloss.Style`s.
+
+```go
+enumeratorStyle := lipgloss.NewStyle().Foreground(lipgloss.Color("99")).MarginRight(1)
+itemStyle := lipgloss.NewStyle().Foreground(lipgloss.Color("10")).MarginRight(1)
+
+l := list.New(
+	"Glossier",
+	"Claire’s Boutique",
+	"Nyx",
+	"Mac",
+	"Milk",
+).
+	Enumerator(list.Roman).
+	EnumeratorStyle(enumeratorStyle).
+	ItemStyle(itemStyle)
+```
+
+Print the list.
+
+<p align="center">
+  <img
+    width="600"
+    alt="List example"
+    src="https://github.com/charmbracelet/lipgloss/assets/245435/8f5e5e0b-7bf9-4e3b-a8ba-3af10825320e"
+  />
+</p>
+In addition to the predefined enumerators (`Arabic`, `Alphabet`, `Roman`, `Bullet`, `Tree`),
+you may also define your own custom enumerator:
+
+```go
+var DuckDuckGooseEnumerator Enumerator = func(l *List, i int) string {
+	if l.At(i) == "Goose" {
+		return "Honk →"
+	}
+	return ""
+}
+```
+
+Use it in a list:
+
+```go
+l := list.New("Duck", "Duck", "Duck", "Duck", "Goose", "Duck", "Duck")
+l.Enumerator(DuckDuckGooseEnumerator)
+```
+
+Print the list:
+
+<p align="center">
+  <img
+    width="600"
+    alt="image"
+    src="https://github.com/charmbracelet/lipgloss/assets/245435/44e37a5b-5124-4f49-a332-1756a355002e"
+  />
+</p>
+
+### Building
+
+If you need, you can also build trees incrementally:
+
+```go
+l := list.New()
+
+for i := 0; i < repeat; i++ {
+	l.Item("Lip Gloss")
+}
+```
 ---
 
 ## FAQ

color.go

@@ -20,7 +20,7 @@ var noColor = NoColor{}
 //
 // Example usage:
 //
-//	var style = someStyle.Copy().Background(lipgloss.NoColor{})
+//	var style = someStyle.Background(lipgloss.NoColor{})
 type NoColor struct{}
 
 func (NoColor) color(*Renderer) termenv.Color {

examples/go.mod

@@ -1,29 +1,44 @@
 module examples
 
-go 1.17
+go 1.19
 
 replace github.com/charmbracelet/lipgloss => ../
 
+replace github.com/charmbracelet/lipgloss/tree => ../tree
+
+replace github.com/charmbracelet/lipgloss/list => ../list
+
 require (
-	github.com/charmbracelet/lipgloss v0.4.0
-	github.com/charmbracelet/wish v0.5.0
-	github.com/gliderlabs/ssh v0.3.4
-	github.com/kr/pty v1.1.1
+	github.com/charmbracelet/lipgloss v0.11.0
+	github.com/charmbracelet/ssh v0.0.0-20240401141849-854cddfa2917
+	github.com/charmbracelet/wish v1.4.0
+	github.com/creack/pty v1.1.21
 	github.com/lucasb-eyer/go-colorful v1.2.0
 	github.com/muesli/termenv v0.15.2
-	golang.org/x/term v0.15.0
+	golang.org/x/term v0.21.0
 )
 
 require (
 	github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be // indirect
 	github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
-	github.com/caarlos0/sshmarshal v0.1.0 // indirect
-	github.com/charmbracelet/keygen v0.3.0 // indirect
-	github.com/charmbracelet/x/ansi v0.1.1 // indirect
+	github.com/charmbracelet/bubbletea v0.25.0 // indirect
+	github.com/charmbracelet/keygen v0.5.0 // indirect
+	github.com/charmbracelet/log v0.4.0 // indirect
+	github.com/charmbracelet/x/ansi v0.1.3 // indirect
+	github.com/charmbracelet/x/errors v0.0.0-20240117030013-d31dba354651 // indirect
+	github.com/charmbracelet/x/exp/term v0.0.0-20240328150354-ab9afc214dfd // indirect
+	github.com/containerd/console v1.0.4-0.20230313162750-1ae8d489ac81 // indirect
+	github.com/go-logfmt/logfmt v0.6.0 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/mattn/go-localereader v0.0.1 // indirect
 	github.com/mattn/go-runewidth v0.0.15 // indirect
-	github.com/mitchellh/go-homedir v1.1.0 // indirect
+	github.com/muesli/ansi v0.0.0-20211018074035-2e021307bc4b // indirect
+	github.com/muesli/cancelreader v0.2.2 // indirect
+	github.com/muesli/reflow v0.3.0 // indirect
 	github.com/rivo/uniseg v0.4.7 // indirect
-	golang.org/x/crypto v0.17.0 // indirect
-	golang.org/x/sys v0.19.0 // indirect
+	golang.org/x/crypto v0.21.0 // indirect
+	golang.org/x/exp v0.0.0-20231006140011-7918f672742d // indirect
+	golang.org/x/sync v0.6.0 // indirect
+	golang.org/x/sys v0.21.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
 )