tui

Documentation

Index

• func NewViewportProgram(initialModel Model) *tea.Program
• func UpdateViewport(content string, width int) tea.Msg
• func UpdateViewportLine(lineNum int, line string) tea.Msg
• type Model
  • func NewModel(title string) Model
  • func (m Model) Init() tea.Cmd
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string
  • func (m Model) WithMinWidth(minWidth int) Model
  • func (m Model) WithViewport(lines []string) Model

Functions

func NewViewportProgram

func NewViewportProgram(initialModel Model) *tea.Program

func UpdateViewport

func UpdateViewport(content string, width int) tea.Msg

func UpdateViewportLine

func UpdateViewportLine(lineNum int, line string) tea.Msg

Types

type Model

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

func NewModel

func NewModel(title string) Model

func (Model) Init

func (m Model) Init() tea.Cmd

default init, does nothing

func (Model) Update

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

update handles key presses and readying the viewport

func (Model) View

func (m Model) View() string

The main view renders the header, viewport and footer

func (Model) WithMinWidth

func (m Model) WithMinWidth(minWidth int) Model

func (Model) WithViewport

func (m Model) WithViewport(lines []string) Model