chore: merge branch 'master' into v2-exp

help/help.go

@@ -119,28 +119,23 @@ func (m Model) ShortHelpView(bindings []key.Binding) string {
 			continue
 		}
 
+		// Sep
 		var sep string
 		if totalWidth > 0 && i < len(bindings) {
 			sep = separator
 		}
 
+		// Item
 		str := sep +
 			m.Styles.ShortKey.Inline(true).Render(kb.Help().Key) + " " +
 			m.Styles.ShortDesc.Inline(true).Render(kb.Help().Desc)
-
 		w := lipgloss.Width(str)
 
-		// If adding this help item would go over the available width, stop
-		// drawing.
-		if m.Width > 0 && totalWidth+w > m.Width {
-			// Although if there's room for an ellipsis, print that.
-			tail := " " + m.Styles.Ellipsis.Inline(true).Render(m.Ellipsis)
-			tailWidth := lipgloss.Width(tail)
-
-			if totalWidth+tailWidth < m.Width {
+		// Tail
+		if tail, ok := m.shouldAddItem(totalWidth, w); !ok {
+			if tail != "" {
 				b.WriteString(tail)
 			}
-
 			break
 		}
 
@@ -165,8 +160,7 @@ func (m Model) FullHelpView(groups [][]key.Binding) string {
 		out []string
 
 		totalWidth int
-		sep        = m.Styles.FullSeparator.Render(m.FullSeparator)
-		sepWidth   = lipgloss.Width(sep)
+		separator  = m.Styles.FullSeparator.Inline(true).Render(m.FullSeparator)
 	)
 
 	// Iterate over groups to build columns
@@ -174,12 +168,17 @@ func (m Model) FullHelpView(groups [][]key.Binding) string {
 		if group == nil || !shouldRenderColumn(group) {
 			continue
 		}
-
 		var (
+			sep          string
 			keys         []string
 			descriptions []string
 		)
 
+		// Sep
+		if totalWidth > 0 && i < len(groups) {
+			sep = separator
+		}
+
 		// Separate keys and descriptions into different slices
 		for _, kb := range group {
 			if !kb.Enabled() {
@@ -189,33 +188,42 @@ func (m Model) FullHelpView(groups [][]key.Binding) string {
 			descriptions = append(descriptions, kb.Help().Desc)
 		}
 
+		// Column
 		col := lipgloss.JoinHorizontal(lipgloss.Top,
+			sep,
 			m.Styles.FullKey.Render(strings.Join(keys, "\n")),
-			m.Styles.FullKey.Render(" "),
+			" ",
 			m.Styles.FullDesc.Render(strings.Join(descriptions, "\n")),
 		)
+		w := lipgloss.Width(col)
 
-		// Column
-		totalWidth += lipgloss.Width(col)
-		if m.Width > 0 && totalWidth > m.Width {
+		// Tail
+		if tail, ok := m.shouldAddItem(totalWidth, w); !ok {
+			if tail != "" {
+				out = append(out, tail)
+			}
 			break
 		}
 
+		totalWidth += w
 		out = append(out, col)
-
-		// Separator
-		if i < len(group)-1 {
-			totalWidth += sepWidth
-			if m.Width > 0 && totalWidth > m.Width {
-				break
-			}
-			out = append(out, sep)
-		}
 	}
 
 	return lipgloss.JoinHorizontal(lipgloss.Top, out...)
 }
 
+func (m Model) shouldAddItem(totalWidth, width int) (tail string, ok bool) {
+	// If there's room for an ellipsis, print that.
+	if m.Width > 0 && totalWidth+width > m.Width {
+		tail = " " + m.Styles.Ellipsis.Inline(true).Render(m.Ellipsis)
+
+		if totalWidth+lipgloss.Width(tail) < m.Width {
+			return tail, false
+		}
+	}
+	return "", true
+}
+
 func shouldRenderColumn(b []key.Binding) (ok bool) {
 	for _, v := range b {
 		if v.Enabled() {

help/help_test.go

@@ -0,0 +1,38 @@
+package help
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/charmbracelet/x/exp/golden"
+
+	"github.com/charmbracelet/bubbles/key"
+)
+
+func TestFullHelp(t *testing.T) {
+	m := New()
+	m.FullSeparator = " | "
+	k := key.WithKeys("x")
+	kb := [][]key.Binding{
+		{
+			key.NewBinding(k, key.WithHelp("enter", "continue")),
+		},
+		{
+			key.NewBinding(k, key.WithHelp("esc", "back")),
+			key.NewBinding(k, key.WithHelp("?", "help")),
+		},
+		{
+			key.NewBinding(k, key.WithHelp("H", "home")),
+			key.NewBinding(k, key.WithHelp("ctrl+c", "quit")),
+			key.NewBinding(k, key.WithHelp("ctrl+l", "log")),
+		},
+	}
+
+	for _, w := range []int{20, 30, 40} {
+		t.Run(fmt.Sprintf("full help %d width", w), func(t *testing.T) {
+			m.Width = w
+			s := m.FullHelpView(kb)
+			golden.RequireEqual(t, []byte(s))
+		})
+	}
+}

help/testdata/TestFullHelp/full_help_20_width.golden

@@ -0,0 +1 @@
+enter continue …

help/testdata/TestFullHelp/full_help_30_width.golden

@@ -0,0 +1,2 @@
+enter continue | esc back …
+                 ?   help  

help/testdata/TestFullHelp/full_help_40_width.golden

@@ -0,0 +1,3 @@
+enter continue | esc back | H      home
+                 ?   help   ctrl+c quit
+                            ctrl+l log