vscroll

package

v1.3.103 Latest Latest Go to latest Published: Oct 12, 2026 License: MIT Imports: 4 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type Model struct {
	// contains filtered or unexported fields
}

Model is a virtualized scroll list that only renders visible items.

func New(width, height int) Model

New creates a new Model with the given viewport dimensions.

func (m Model) AppendItem(item string) Model

AppendItem adds one item to the end. If followBottom is true, the view auto-scrolls to show the new content.

func (m Model) AtBottom() bool

AtBottom reports whether the viewport is scrolled to the bottom.

func (m Model) GotoBottom() Model

GotoBottom scrolls to the very bottom.

func (m Model) GotoTop() Model

GotoTop scrolls to the very top.

func (m Model) ItemCount() int

ItemCount returns the number of items.

func (m Model) SetItems(items []string) Model

SetItems replaces all items and returns the updated Model.

func (m Model) SetSize(width, height int) Model

SetSize returns a new Model with updated viewport dimensions.

func (m Model) SetStyle(style lipgloss.Style) Model

SetStyle returns a new Model with the given lipgloss style applied.

func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)

Update handles keyboard and mouse messages for scrolling.

func (m Model) View() string

View renders the visible window of the scroll list.