list.go 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  1. package list
  2. import (
  3. "strings"
  4. "github.com/charmbracelet/bubbles/v2/key"
  5. tea "github.com/charmbracelet/bubbletea/v2"
  6. )
  7. type ListItem interface {
  8. Render(selected bool, width int) string
  9. }
  10. type List[T ListItem] interface {
  11. tea.Model
  12. tea.ViewModel
  13. SetMaxWidth(maxWidth int)
  14. GetSelectedItem() (item T, idx int)
  15. SetItems(items []T)
  16. GetItems() []T
  17. SetSelectedIndex(idx int)
  18. SetEmptyMessage(msg string)
  19. IsEmpty() bool
  20. }
  21. type listComponent[T ListItem] struct {
  22. fallbackMsg string
  23. items []T
  24. selectedIdx int
  25. maxWidth int
  26. maxVisibleItems int
  27. useAlphaNumericKeys bool
  28. width int
  29. height int
  30. }
  31. type listKeyMap struct {
  32. Up key.Binding
  33. Down key.Binding
  34. UpAlpha key.Binding
  35. DownAlpha key.Binding
  36. }
  37. var simpleListKeys = listKeyMap{
  38. Up: key.NewBinding(
  39. key.WithKeys("up"),
  40. key.WithHelp("↑", "previous list item"),
  41. ),
  42. Down: key.NewBinding(
  43. key.WithKeys("down"),
  44. key.WithHelp("↓", "next list item"),
  45. ),
  46. UpAlpha: key.NewBinding(
  47. key.WithKeys("k"),
  48. key.WithHelp("k", "previous list item"),
  49. ),
  50. DownAlpha: key.NewBinding(
  51. key.WithKeys("j"),
  52. key.WithHelp("j", "next list item"),
  53. ),
  54. }
  55. func (c *listComponent[T]) Init() tea.Cmd {
  56. return nil
  57. }
  58. func (c *listComponent[T]) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
  59. switch msg := msg.(type) {
  60. case tea.KeyMsg:
  61. switch {
  62. case key.Matches(msg, simpleListKeys.Up) || (c.useAlphaNumericKeys && key.Matches(msg, simpleListKeys.UpAlpha)):
  63. if c.selectedIdx > 0 {
  64. c.selectedIdx--
  65. }
  66. return c, nil
  67. case key.Matches(msg, simpleListKeys.Down) || (c.useAlphaNumericKeys && key.Matches(msg, simpleListKeys.DownAlpha)):
  68. if c.selectedIdx < len(c.items)-1 {
  69. c.selectedIdx++
  70. }
  71. return c, nil
  72. }
  73. }
  74. return c, nil
  75. }
  76. func (c *listComponent[T]) GetSelectedItem() (T, int) {
  77. if len(c.items) > 0 {
  78. return c.items[c.selectedIdx], c.selectedIdx
  79. }
  80. var zero T
  81. return zero, -1
  82. }
  83. func (c *listComponent[T]) SetItems(items []T) {
  84. c.selectedIdx = 0
  85. c.items = items
  86. }
  87. func (c *listComponent[T]) GetItems() []T {
  88. return c.items
  89. }
  90. func (c *listComponent[T]) SetEmptyMessage(msg string) {
  91. c.fallbackMsg = msg
  92. }
  93. func (c *listComponent[T]) IsEmpty() bool {
  94. return len(c.items) == 0
  95. }
  96. func (c *listComponent[T]) SetMaxWidth(width int) {
  97. c.maxWidth = width
  98. }
  99. func (c *listComponent[T]) SetSelectedIndex(idx int) {
  100. if idx >= 0 && idx < len(c.items) {
  101. c.selectedIdx = idx
  102. }
  103. }
  104. func (c *listComponent[T]) View() string {
  105. items := c.items
  106. maxWidth := c.maxWidth
  107. maxVisibleItems := min(c.maxVisibleItems, len(items))
  108. startIdx := 0
  109. if len(items) <= 0 {
  110. return c.fallbackMsg
  111. }
  112. if len(items) > maxVisibleItems {
  113. halfVisible := maxVisibleItems / 2
  114. if c.selectedIdx >= halfVisible && c.selectedIdx < len(items)-halfVisible {
  115. startIdx = c.selectedIdx - halfVisible
  116. } else if c.selectedIdx >= len(items)-halfVisible {
  117. startIdx = len(items) - maxVisibleItems
  118. }
  119. }
  120. endIdx := min(startIdx+maxVisibleItems, len(items))
  121. listItems := make([]string, 0, maxVisibleItems)
  122. for i := startIdx; i < endIdx; i++ {
  123. item := items[i]
  124. title := item.Render(i == c.selectedIdx, maxWidth)
  125. listItems = append(listItems, title)
  126. }
  127. return strings.Join(listItems, "\n")
  128. }
  129. func NewListComponent[T ListItem](items []T, maxVisibleItems int, fallbackMsg string, useAlphaNumericKeys bool) List[T] {
  130. return &listComponent[T]{
  131. fallbackMsg: fallbackMsg,
  132. items: items,
  133. maxVisibleItems: maxVisibleItems,
  134. useAlphaNumericKeys: useAlphaNumericKeys,
  135. selectedIdx: 0,
  136. }
  137. }