tui

Documentation

Overview

Package tui contains types and logic for the interactive TUI part of Gopen.

Index

• func StartTUI(cfg config.C) *tea.Program
• type Model
  • func (m Model) Init() tea.Cmd
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string

Functions

func StartTUI

func StartTUI(cfg config.C) *tea.Program

StartTUI is the entry point for the interactive TUI which spawns the bubbletea program.

Types

type Model

type Model struct {
	Config   config.C
	Selected string
	// contains filtered or unexported fields
}

Model implements the tea.Model interface to be used as the model part of the bubbletea program and includes fields that hold the program state.

Note that the fields `Config` and `Selected` are exported because the are used by the main package.

func (Model) Init

func (m Model) Init() tea.Cmd

Init is one of the tea.Model interface methods but not used by the TUI.

func (Model) Update

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

Update is one of the tea.Model interface methods. It triggers updates to the model and its state on keypresses.

func (Model) View

func (m Model) View() string

View is one of the tea.Model interface methods. It includes the rendering logic.