bubbles/table/table.go

package table

import (
	"strings"

	"github.com/charmbracelet/bubbles/help"
	"github.com/charmbracelet/bubbles/key"
	"github.com/charmbracelet/bubbles/viewport"
	tea "github.com/charmbracelet/bubbletea"
	"github.com/charmbracelet/lipgloss"
	"github.com/charmbracelet/lipgloss/table"
)

const HEADER int = 0

// Model defines a state for the table widget.
type Model struct {
	KeyMap KeyMap
	Help   help.Model

	YOffset int
	Height  int
	headers []string
	rows    [][]string
	cursor  int
	focus   bool
	styles  Styles

	table *table.Table
	start int
	end   int

	// deprecated: don't use viewport, use table instead.
	viewport viewport.Model
}

// Row represents one line in the table.
// Deprecated: use []string.
type Row []string

// Column defines the table structure.
// Deprecated: use []string.
type Column struct {
	Title string
	Width int
}

// KeyMap defines keybindings. It satisfies to the help.KeyMap interface, which
// is used to render the help menu.
type KeyMap struct {
	LineUp       key.Binding
	LineDown     key.Binding
	PageUp       key.Binding
	PageDown     key.Binding
	HalfPageUp   key.Binding
	HalfPageDown key.Binding
	GotoTop      key.Binding
	GotoBottom   key.Binding
}

// ShortHelp implements the KeyMap interface.
func (km KeyMap) ShortHelp() []key.Binding {
	return []key.Binding{km.LineUp, km.LineDown}
}

// FullHelp implements the KeyMap interface.
func (km KeyMap) FullHelp() [][]key.Binding {
	return [][]key.Binding{
		{km.LineUp, km.LineDown, km.GotoTop, km.GotoBottom},
		{km.PageUp, km.PageDown, km.HalfPageUp, km.HalfPageDown},
	}
}

// DefaultKeyMap returns a default set of keybindings.
func DefaultKeyMap() KeyMap {
	const spacebar = " "
	return KeyMap{
		LineUp: key.NewBinding(
			key.WithKeys("up", "k"),
			key.WithHelp("↑/k", "up"),
		),
		LineDown: key.NewBinding(
			key.WithKeys("down", "j"),
			key.WithHelp("↓/j", "down"),
		),
		PageUp: key.NewBinding(
			key.WithKeys("b", "pgup"),
			key.WithHelp("b/pgup", "page up"),
		),
		PageDown: key.NewBinding(
			key.WithKeys("f", "pgdown", spacebar),
			key.WithHelp("f/pgdn", "page down"),
		),
		HalfPageUp: key.NewBinding(
			key.WithKeys("u", "ctrl+u"),
			key.WithHelp("u", "½ page up"),
		),
		HalfPageDown: key.NewBinding(
			key.WithKeys("d", "ctrl+d"),
			key.WithHelp("d", "½ page down"),
		),
		GotoTop: key.NewBinding(
			key.WithKeys("home", "g"),
			key.WithHelp("g/home", "go to start"),
		),
		GotoBottom: key.NewBinding(
			key.WithKeys("end", "G"),
			key.WithHelp("G/end", "go to end"),
		),
	}
}

// Styles contains style definitions for this list component. By default, these
// values are generated by DefaultStyles.
type Styles struct {
	// TODO is there a way to extract the border from the style?
	Border lipgloss.Border
	// Why doesn't setting the BorderStyle overwrite the default lip gloss table border?
	BorderStyle lipgloss.Style
	Header      lipgloss.Style
	Cell        lipgloss.Style
	Selected    lipgloss.Style
}

// DefaultStyles returns a set of default style definitions for this table.
func DefaultStyles() Styles {
	return Styles{
		BorderStyle: lipgloss.NewStyle().BorderStyle(lipgloss.HiddenBorder()),
		Selected:    lipgloss.NewStyle().Bold(true).Foreground(lipgloss.Color("212")),
		Header:      lipgloss.NewStyle().Bold(true).Padding(0, 1),
		Cell:        lipgloss.NewStyle().Padding(0, 1),
	}
}

// SetStyles sets the table styles.
func (m *Model) SetStyles(s Styles) {
	m.styles = s
	m.table.BorderStyle(s.BorderStyle)
	m.table.StyleFunc(func(row, col int) lipgloss.Style {
		if row == HEADER {
			return s.Header
		}
		if row == m.cursor {
			return s.Selected
		}
		return s.Cell
	})
}

// Option is used to set options in New. For example:
//
//	table := New(WithColumns([]Column{{Title: "ID", Width: 10}}))
type Option func(*Model)

// New creates a new model for the table widget.
func New(opts ...Option) *Model {
	m := &Model{
		cursor: 0,
		table:  table.New(),
		KeyMap: DefaultKeyMap(),
		Help:   help.New(),
		styles: DefaultStyles(),
	}

	for _, opt := range opts {
		opt(m)
	}

	return m
}

// Headers sets the table headers.
func (m *Model) Headers(headers ...string) *Model {
	m.headers = headers
	m.table.Headers(headers...)
	return m
}

// WithColumns sets the table columns (headers).
// Deprecated: use Headers instead.
func WithColumns(cols []Column) Option {
	return func(m *Model) {
		m.Headers(colToString(cols)...)
	}
}

// Rows appends rows to the table
func (m *Model) Rows(rows ...[]string) *Model {
	m.rows = append(m.rows, rows...)
	m.table.Rows(rows...)
	return m
}

// rowToString helper to unwrap the Row type.
func rowToString(rows []Row) [][]string {
	var out [][]string
	for _, row := range rows {
		var newRow []string
		for _, val := range row {
			newRow = append(newRow, val)
		}
		out = append(out, newRow)
	}
	return out
}

// rowToString helper to unwrap the Row type.
func colToString(cols []Column) []string {
	var out []string
	for _, col := range cols {
		out = append(out, col.Title)
	}
	return out
}

// WithRows sets the table rows (data).
// Deprecated: use Rows instead.
func WithRows(rows []Row) Option {
	return func(m *Model) {
		rows := rowToString(rows)
		m.rows = rows
		m.table.Rows(rows...)
	}
}

/* options */

// WithHeight sets the height of the table.
func WithHeight(h int) Option {
	return func(m *Model) {
		m.table.Height(h)
	}
}

// WithWidth sets the width of the table.
func WithWidth(w int) Option {
	return func(m *Model) {
		m.viewport.Width = w
	}
}

// WithFocused sets the focus state of the table.
func WithFocused(f bool) Option {
	return func(m *Model) {
		m.focus = f
	}
}

// WithStyles sets the table styles.
func WithStyles(s Styles) Option {
	return func(m *Model) {
		m.SetStyles(s)
	}
}

// WithKeyMap sets the key map.
func WithKeyMap(km KeyMap) Option {
	return func(m *Model) {
		m.KeyMap = km
	}
}

// Update for the Bubble Tea update loop.
func (m Model) Update(msg tea.Msg) (Model, tea.Cmd) {
	if !m.focus {
		return m, nil
	}

	switch msg := msg.(type) {
	case tea.KeyMsg:
		switch {
		case key.Matches(msg, m.KeyMap.LineUp):
			m.MoveUp(1)
		case key.Matches(msg, m.KeyMap.LineDown):
			m.MoveDown(1)
		case key.Matches(msg, m.KeyMap.PageUp):
			m.MoveUp(m.viewport.Height)
		case key.Matches(msg, m.KeyMap.PageDown):
			m.MoveDown(m.viewport.Height)
		case key.Matches(msg, m.KeyMap.HalfPageUp):
			m.MoveUp(m.viewport.Height / 2)
		case key.Matches(msg, m.KeyMap.HalfPageDown):
			m.MoveDown(m.viewport.Height / 2)
		case key.Matches(msg, m.KeyMap.LineDown):
			m.MoveDown(1)
		case key.Matches(msg, m.KeyMap.GotoTop):
			m.GotoTop()
		case key.Matches(msg, m.KeyMap.GotoBottom):
			m.GotoBottom()
		}
	}

	return m, nil
}

// Focused returns the focus state of the table.
func (m Model) Focused() bool {
	return m.focus
}

// Focus focuses the table, allowing the user to move around the rows and
// interact.
func (m *Model) Focus() {
	m.focus = true
}

// Blur blurs the table, preventing selection or movement.
func (m *Model) Blur() {
	m.focus = false
}

// View renders the component.
func (m Model) View() string {
	return m.table.String()
}

// HelpView is a helper method for rendering the help menu from the keymap.
// Note that this view is not rendered by default and you must call it
// manually in your application, where applicable.
func (m Model) HelpView() string {
	return m.Help.View(m.KeyMap)
}

// SelectedRow returns the selected row.
// You can cast it to your own implementation.
func (m Model) SelectedRow() Row {
	if m.cursor < 0 || m.cursor >= len(m.rows) {
		return nil
	}

	return m.rows[m.cursor]
}

// SetRows sets the table content to the new value, overwriting previous values.
func (m *Model) SetRows(r []Row) {
	rows := rowToString(r)
	m.rows = rows
	m.table.ClearRows().Rows(rows...)
}

// SetWidth sets the width of the viewport of the table.
func (m *Model) SetWidth(w int) {
	m.table.Width(w)
}

// SetHeight sets the height of the viewport of the table.
func (m *Model) SetHeight(h int) {
	m.Height = h
	m.table.Height(h)
}

// Cursor returns the index of the selected row.
func (m Model) Cursor() int {
	return m.cursor
}

// SetCursor sets the cursor position in the table.
func (m *Model) SetCursor(n int) {
	m.cursor = clamp(n, 0, len(m.rows)-1)
}

// MoveUp moves the selection up by any number of rows.
// It can not go above the first row.
func (m *Model) MoveUp(n int) {
	//	m.SetCursor(m.cursor-n)
	m.cursor = clamp(m.cursor-n, 0, len(m.rows)-1)
	switch {
	case m.start == 0:
		m.YOffset = clamp(m.viewport.YOffset, 0, m.cursor)
	case m.start < m.viewport.Height:
		m.viewport.YOffset = (clamp(clamp(m.YOffset+n, 0, m.cursor), 0, m.Height))
	case m.YOffset >= 1:
		m.YOffset = clamp(m.YOffset+n, 1, m.Height)
	}
	m.table.Offset(m.YOffset)
}

// MoveDown moves the selection down by any number of rows.
// It can not go below the last row.
func (m *Model) MoveDown(n int) {
	// TODO make this call SetCursor instead?
	m.SetCursor(m.cursor + n)

	switch {
	case m.end == len(m.rows) && m.YOffset > 0:
		m.YOffset = clamp(m.YOffset-n, 1, m.Height)
	case m.cursor > (m.end-m.start)/2 && m.YOffset > 0:
		m.YOffset = clamp(m.YOffset-n, 1, m.cursor)
	case m.YOffset > 1:
	case m.cursor > m.YOffset+m.Height-1:
		m.YOffset = clamp(m.YOffset+1, 0, 1)
	}
	// update table offset
	m.table.Offset(m.YOffset)
}

// GotoTop moves the selection to the first row.
func (m *Model) GotoTop() {
	// m.MoveUp(m.cursor)
	m.cursor = HEADER + 1
}

// GotoBottom moves the selection to the last row.
func (m *Model) GotoBottom() {
	//	m.MoveDown(len(m.rows))
	m.cursor = len(m.rows)
}

// FromValues create the table rows from a simple string. It uses `\n` by
// default for getting all the rows and the given separator for the fields on
// each row.
func (m *Model) FromValues(value, separator string) {
	rows := []Row{}
	for _, line := range strings.Split(value, "\n") {
		r := Row{}
		for _, field := range strings.Split(line, separator) {
			r = append(r, field)
		}
		rows = append(rows, r)
	}

	m.SetRows(rows)
}

// func (m Model) headersView() string {
// 	s := make([]string, 0, len(m.cols))
// 	for _, col := range m.cols {
// 		if col.Width <= 0 {
// 			continue
// 		}
// 		style := lipgloss.NewStyle().Width(col.Width).MaxWidth(col.Width).Inline(true)
// 		renderedCell := style.Render(runewidth.Truncate(col.Title, col.Width, "…"))
// 		s = append(s, m.styles.Header.Render(renderedCell))
// 	}
// 	return lipgloss.JoinHorizontal(lipgloss.Top, s...)
// }

// func (m *Model) renderRow(r int) string {
// 	s := make([]string, 0, len(m.headers))
// 	for i, value := range m.rows[r] {
// 		if m.headers[i].Width <= 0 {
// 			continue
// 		}
// 		style := lipgloss.NewStyle().Width(m.headers[i].Width).MaxWidth(m.headers[i].Width).Inline(true)
// 		renderedCell := m.styles.Cell.Render(style.Render(runewidth.Truncate(value, m.headers[i].Width, "…")))
// 		s = append(s, renderedCell)
// 	}
//
// 	row := lipgloss.JoinHorizontal(lipgloss.Top, s...)
//
// 	if r == m.cursor {
// 		return m.styles.Selected.Render(row)
// 	}
//
// 	return row
// }

func max(a, b int) int {
	if a > b {
		return a
	}

	return b
}

func min(a, b int) int {
	if a < b {
		return a
	}

	return b
}

func clamp(v, low, high int) int {
	return min(max(v, low), high)
}