viewport

Documentation

Overview

Package viewport provides a scrollable view into content.

Index

• func View(m Model, content string) string
• type Model
  • func Update(msg tea.Msg, m Model) Model

Functions

func View

func View(m Model, content string) string

View function.

Types

type Model

type Model struct {
	// Height is the viewport height, usually the terminal height.
	Height int

	// ScrollHeight is the scrollable height.
	ScrollHeight int

	// ScrollY is the vertical scroll position.
	ScrollY int

	// ScrollBy is the number of rows or columns to scroll by.
	ScrollBy int
}

Model is the viewport model.

func Update

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

Update function.