renaming local variables, add configurability, changing test samples

- added field for costumising the unselected marker
- added WrapPrefix to turn of the selected marker by wraped lines
- renamed some varibales to (hopefully) better names
- turned of wraping of lines when wrap is not enabled
- added Focus to be able to ignore keypresses
  Warning: You can still change the state by surpassing the Update and
  use the Methodes directly! this raises the question if focus should
  also affect the Methodes and if false return a error.?
- removed newlines from the ends of the (golden) test samples,
  since it would subtract a line from the View's height

Author: Kilian Drechsler

list/example/main.go

@@ -63,6 +63,9 @@ func main() {
 func initialize(lineList []string, endResult chan<- string) func() (tea.Model, tea.Cmd) {
 	l := list.NewModel()
 	l.AddItems(lineList)
+	// l.WrapPrefix = false // uncomment for fancy check (selected) box :-)
+	// l.SelectedPrefix = " [x]"
+	// l.UnSelectedPrefix = "[ ]"
 
 	return func() (tea.Model, tea.Cmd) { return model{list: l, endResult: endResult}, nil }
 }

list/list.go

@@ -26,10 +26,13 @@ type Model struct {
 
 	Wrap bool
 
-	SelectedPrefix string
-	Seperator      string
-	SeperatorWrap  string
-	CurrentMarker  string
+	SelectedPrefix   string
+	UnSelectedPrefix string
+	Seperator        string
+	SeperatorWrap    string
+	CurrentMarker    string
+
+	WrapPrefix bool
 
 	Number         bool
 	NumberRelative bool
@@ -98,20 +101,34 @@ func (m *Model) Lines() []string {
 
 	// pad all prefixes to the same width for easy exchange
 	prefix := m.SelectedPrefix
-	preWidth := ansi.PrintableRuneWidth(prefix)
-	prepad := strings.Repeat(" ", preWidth)
+	prepad := m.UnSelectedPrefix
+	preWid := ansi.PrintableRuneWidth(prefix)
+	tmpWid := ansi.PrintableRuneWidth(prepad)
+
+	preWidth := preWid
+	if tmpWid > preWidth {
+		preWidth = tmpWid
+	}
+	prefix = strings.Repeat(" ", preWidth-preWid) + prefix
+
+	wrapPrePad := prepad
+	if !m.WrapPrefix {
+		wrapPrePad = strings.Repeat(" ", preWidth)
+	}
+
+	prepad = strings.Repeat(" ", preWidth-tmpWid) + prepad
 
 	// pad all seperators to the same width for easy exchange
 	sepItem := strings.Repeat(" ", sepWidth-widthItem) + m.Seperator
 	sepWrap := strings.Repeat(" ", sepWidth-widthWrap) + m.SeperatorWrap
 
 	// pad right of prefix, with lenght of current pointer
-	suffix := m.CurrentMarker
-	sufWidth := ansi.PrintableRuneWidth(suffix)
-	sufpad := strings.Repeat(" ", sufWidth)
+	mark := m.CurrentMarker
+	markWidth := ansi.PrintableRuneWidth(mark)
+	unmark := strings.Repeat(" ", markWidth)
 
 	// Get the hole prefix width
-	holePrefixWidth := numWidth + preWidth + sepWidth + sufWidth
+	holePrefixWidth := numWidth + preWidth + sepWidth + markWidth
 
 	// Get actual content width
 	contentWidth := width - holePrefixWidth
@@ -121,9 +138,13 @@ func (m *Model) Lines() []string {
 		panic("Can't display with zero width for content")
 	}
 
-	// renew wrap of all items TODO check if to slow
-	for i := range m.listItems {
-		m.listItems[i] = m.listItems[i].genVisLines(contentWidth)
+	// If set
+	wrap := m.Wrap
+	if wrap {
+		// renew wrap of all items
+		for i := range m.listItems {
+			m.listItems[i] = m.listItems[i].genVisLines(contentWidth)
+		}
 	}
 
 	var visLines int
@@ -137,7 +158,7 @@ out:
 		}
 
 		item := m.listItems[index]
-		if item.wrapedLenght <= 0 {
+		if wrap && item.wrapedLenght <= 0 {
 			panic("cant display item with no visible content")
 		}
 
@@ -163,15 +184,19 @@ out:
 		}
 
 		// Current: handel highlighting of current item/first-line
-		curPad := sufpad
+		curPad := unmark
 		if index == m.curIndex {
 			style = m.CurrentStyle
-			curPad = suffix
+			curPad = mark
 		}
 
 		// join all prefixes
-		linePrefix := strings.Join([]string{firstPad, selString, sepItem, curPad}, "")
-		wrapPrefix := strings.Join([]string{wrapPad, selString, sepWrap, sufpad}, "") // dont prefix wrap lines with CurrentMarker (suffix)
+		var wrapPrefix, linePrefix string
+
+		linePrefix = strings.Join([]string{firstPad, selString, sepItem, curPad}, "")
+		if wrap {
+			wrapPrefix = strings.Join([]string{wrapPad, wrapPrePad, sepWrap, unmark}, "") // dont prefix wrap lines with CurrentMarker (suffix)
+		}
 
 		// join pad and first line content
 		// NOTE linebreak is not added here because it would mess with the highlighting
@@ -187,7 +212,7 @@ out:
 		}
 
 		// Dont write wraped lines if not set
-		if !m.Wrap || item.wrapedLenght <= 1 {
+		if !wrap || item.wrapedLenght <= 1 {
 			continue
 		}
 
@@ -226,6 +251,9 @@ func lineNumber(relativ bool, curser, current int) int {
 
 // Update changes the Model of the List according to the messages recieved
 func Update(msg tea.Msg, m Model) (Model, tea.Cmd) {
+	if !m.focus {
+		return m, nil
+	}
 	var cmd tea.Cmd
 
 	switch msg := msg.(type) {
@@ -366,17 +394,28 @@ func (m *Model) Move(amount int) error {
 func NewModel() Model {
 	p := termenv.ColorProfile()
 	selStyle := termenv.Style{}.Background(p.Color("#ff0000"))
+	// just reverse colors to keep there information
 	curStyle := termenv.Style{}.Reverse()
 	return Model{
+		// Accept keypresses
+		focus: true,
+
+		// Try to keep $CurserOffset lines between Cursor and screen Border
 		CurserOffset: 5,
 
+		// Wrap lines to have no loss of information
 		Wrap: true,
 
-		Seperator:      "╭",
-		SeperatorWrap:  "│",
+		// Make clear where a item begins and where it ends
+		Seperator:     "╭",
+		SeperatorWrap: "│",
+
+		// Mark it so that even without color support all is explicit
 		CurrentMarker:  ">",
 		SelectedPrefix: "*",
-		Number:         true,
+
+		// enable Linenumber
+		Number: true,
 
 		less: func(k, l string) bool {
 			return k < l
@@ -544,3 +583,18 @@ func (m *Model) CheckWithinBorder(index int) bool {
 //func (m *Model) AddDataItem(content string, data interface{}) {
 //	m.listItems = append(m.listItems, item{content: content, userValue: data})
 //}
+
+// Focus sets the list Model focus so it accepts keyinput and responds to them
+func (m *Model) Focus() {
+	m.focus = true
+}
+
+// UnFocus removes the focus so that the list Model does NOT responed to key presses
+func (m *Model) UnFocus() {
+	m.focus = false
+}
+
+// Focused returns if the list Model is focused and acccepts keypresses
+func (m *Model) Focused() bool {
+	return m.focus
+}

list/list_test.go

@@ -104,7 +104,7 @@ func genTestModels() []test {
 			[]string{
 				"",
 			},
-			"\x1b[7m0 ╭>\x1b[0m\n",
+			"\x1b[7m0 ╭>\x1b[0m",
 		},
 		// if exceding the boards and softwrap (at word bounderys are possible
 		// wrap there. Dont increment the item number because its still the same item.
@@ -114,7 +114,7 @@ func genTestModels() []test {
 			[]string{
 				"robert frost",
 			},
-			"\x1b[7m0 ╭>robert\x1b[0m\n\x1b[7m  │ frost\x1b[0m\n",
+			"\x1b[7m0 ╭>robert\x1b[0m\n\x1b[7m  │ frost\x1b[0m",
 		},
 		{
 			10,
@@ -129,8 +129,7 @@ func genTestModels() []test {
 6 ╭ 
 7 ╭ 
 8 ╭ 
-9 ╭ 
-`,
+9 ╭ `,
 		},
 	}
 }
@@ -177,7 +176,7 @@ func genDynamicModels() []testModel {
 	moveDown.Down()
 	return []testModel{
 		{model: moveBottom,
-			shouldBe:     "0 ╭ \n1 ╭ \n2 ╭ \n\x1b[7m3 ╭>\x1b[0m\n",
+			shouldBe:     "0 ╭ \n1 ╭ \n2 ╭ \n\x1b[7m3 ╭>\x1b[0m",
 			afterMethode: "Bottom",
 		},
 		{model: moveDown,
@@ -230,8 +229,7 @@ func genDynamicModels() []testModel {
 				`47 ╭ 
 48 ╭ 
 49 ╭ 
-50 ╭ 
-`,
+50 ╭ `,
 			afterMethode: "Down",
 		},
 	}