From 6348d5941fae86fc2637bc3ff0ae8acd146db06d Mon Sep 17 00:00:00 2001
From: Maas Lalani <maas@lalani.dev>
Date: Thu, 11 Jul 2024 17:32:15 -0400
Subject: [PATCH] docs: list documentation (#331)

---
 README.md | 189 ++++++++++++++----------------------------------------
 1 file changed, 48 insertions(+), 141 deletions(-)

diff --git a/README.md b/README.md
index 9fbb84a..4f21434 100644
--- a/README.md
+++ b/README.md
@@ -455,114 +455,9 @@ 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"
@@ -584,77 +479,89 @@ fmt.Println(l)
 // • C
 ```
 
+Lists have the ability to nest.
 
-### Customization
+```go
+l := list.New(
+  "A", list.New("Artichoke"),
+  "B", list.New("Baking Flour", "Bananas", "Barley", "Bean Sprouts"),
+  "C", list.New("Cashew Apple", "Cashews", "Coconut Milk", "Curry Paste", "Currywurst"),
+  "D", list.New("Dill", "Dragonfruit", "Dried Shrimp"),
+  "E", list.New("Eggs"),
+  "F", list.New("Fish Cake", "Furikake"),
+  "J", list.New("Jicama"),
+  "K", list.New("Kohlrabi"),
+  "L", list.New("Leeks", "Lentils", "Licorice Root"),
+)
+```
+
+Print the list.
+
+```go
+fmt.Println(l)
+```
+
+<p align="center">
+<img width="600" alt="image" src="https://github.com/charmbracelet/lipgloss/assets/42545625/0dc9f440-0748-4151-a3b0-7dcf29dfcdb0">
+</p>
 
 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)
+itemStyle := lipgloss.NewStyle().Foreground(lipgloss.Color("212")).MarginRight(1)
 
 l := list.New(
-	"Glossier",
-	"Claire’s Boutique",
-	"Nyx",
-	"Mac",
-	"Milk",
+  "Glossier",
+  "Claire’s Boutique",
+  "Nyx",
+  "Mac",
+  "Milk",
 ).
-	Enumerator(list.Roman).
-	EnumeratorStyle(enumeratorStyle).
-	ItemStyle(itemStyle)
+  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"
-  />
+<img width="600" alt="List example" src="https://github.com/charmbracelet/lipgloss/assets/42545625/360494f1-57fb-4e13-bc19-0006efe01561">
 </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)
+
+func DuckDuckGooseEnumerator(l list.Items, i int) string {
+    if l.At(i).Value() == "Goose" {
+        return "Honk →"
+    }
+    return ""
+}
+
+l = 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"
-  />
+<img width="600" alt="image" src="https://github.com/charmbracelet/lipgloss/assets/42545625/157aaf30-140d-4948-9bb4-dfba46e5b87e">
 </p>
 
-### Building
-
-If you need, you can also build trees incrementally:
+If you need, you can also build lists incrementally:
 
 ```go
 l := list.New()
 
 for i := 0; i < repeat; i++ {
-	l.Item("Lip Gloss")
+    l.Item("Lip Gloss")
 }
 ```
+
 ---
 
 ## FAQ