Table: wrap cursor on line up and line down

table/table.go

@@ -22,9 +22,10 @@ type Model struct {
 	focus  bool
 	styles Styles
 
-	viewport viewport.Model
-	start    int
-	end      int
+	viewport   viewport.Model
+	start      int
+	end        int
+	wrapCursor bool
 }
 
 // Row represents one line in the table.
@@ -135,9 +136,10 @@ func New(opts ...Option) Model {
 		cursor:   0,
 		viewport: viewport.New(0, 20), //nolint:mnd
 
-		KeyMap: DefaultKeyMap(),
-		Help:   help.New(),
-		styles: DefaultStyles(),
+		KeyMap:     DefaultKeyMap(),
+		Help:       help.New(),
+		styles:     DefaultStyles(),
+		wrapCursor: true,
 	}
 
 	for _, opt := range opts {
@@ -198,6 +200,14 @@ func WithKeyMap(km KeyMap) Option {
 	}
 }
 
+// WithWrapCursor sets whether the cursor should be wrapped to opposite end on
+// LineUp and LineDown. Default is true.
+func WithWrapCursor(wrapCursor bool) Option {
+	return func(m *Model) {
+		m.wrapCursor = wrapCursor
+	}
+}
+
 // Update is the Bubble Tea update loop.
 func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
 	if !m.focus {
@@ -208,9 +218,17 @@ func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
 	case tea.KeyMsg:
 		switch {
 		case key.Matches(msg, m.KeyMap.LineUp):
-			m.MoveUp(1)
+			if m.cursor == 0 && m.wrapCursor {
+				m.SetCursor(len(m.rows) - 1)
+			} else {
+				m.MoveUp(1)
+			}
 		case key.Matches(msg, m.KeyMap.LineDown):
-			m.MoveDown(1)
+			if m.cursor == len(m.rows)-1 && m.wrapCursor {
+				m.SetCursor(0)
+			} else {
+				m.MoveDown(1)
+			}
 		case key.Matches(msg, m.KeyMap.PageUp):
 			m.MoveUp(m.viewport.Height)
 		case key.Matches(msg, m.KeyMap.PageDown):

table/table_test.go

@@ -3,6 +3,7 @@ package table
 import (
 	"testing"
 
+	tea "github.com/charmbracelet/bubbletea"
 	"github.com/charmbracelet/lipgloss"
 	"github.com/charmbracelet/x/ansi"
 	"github.com/charmbracelet/x/exp/golden"
@@ -157,3 +158,49 @@ func TestTableAlignment(t *testing.T) {
 		golden.RequireEqual(t, []byte(got))
 	})
 }
+
+func TestWrapCursor(t *testing.T) {
+	baseOptions := []Option{
+		WithColumns([]Column{
+			{Title: "Col1", Width: 10},
+		}),
+		WithRows([]Row{
+			{"First"},
+			{"Second"},
+			{"Third"},
+		}),
+		WithFocused(true),
+	}
+	t.Run("with default settings, wraps cursor to bottom on up", func(t *testing.T) {
+		model := New(baseOptions...)
+		model, _ = model.Update(tea.KeyMsg{Type: tea.KeyUp})
+		if model.Cursor() != 2 {
+			t.Fatal("Expected cursor to be 2, actual value ", model.Cursor())
+		}
+	})
+	t.Run("with default settings, wraps cursor to top on down", func(t *testing.T) {
+		model := New(baseOptions...)
+		model, _ = model.Update(tea.KeyMsg{Type: tea.KeyDown})
+		model, _ = model.Update(tea.KeyMsg{Type: tea.KeyDown})
+		model, _ = model.Update(tea.KeyMsg{Type: tea.KeyDown})
+		if model.Cursor() != 0 {
+			t.Fatal("Expected cursor to be 0, actual value ", model.Cursor())
+		}
+	})
+	t.Run("with wrap cursor off, does not wrap on up", func(t *testing.T) {
+		model := New(append(baseOptions, WithWrapCursor(false))...)
+		model, _ = model.Update(tea.KeyMsg{Type: tea.KeyUp})
+		if model.Cursor() != 0 {
+			t.Fatal("Expected cursor to be 0, actual value ", model.Cursor())
+		}
+	})
+	t.Run("with wrap cursor off, does not wrap on down", func(t *testing.T) {
+		model := New(append(baseOptions, WithWrapCursor(false))...)
+		model, _ = model.Update(tea.KeyMsg{Type: tea.KeyDown})
+		model, _ = model.Update(tea.KeyMsg{Type: tea.KeyDown})
+		model, _ = model.Update(tea.KeyMsg{Type: tea.KeyDown})
+		if model.Cursor() != 2 {
+			t.Fatal("Expected cursor to be 2, actual value ", model.Cursor())
+		}
+	})
+}