appframe

Documentation

Index

• type AppFrame
  • func NewAppFrame(appName string, components []*con.Component) (output AppFrame)
  • func (m AppFrame) Init() tea.Cmd
  • func (m AppFrame) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m AppFrame) View() string

Types

type AppFrame

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

The root model for a TUI program that includes a navstack and an actionbar/command-palette

func NewAppFrame

func NewAppFrame(appName string, components []*con.Component) (output AppFrame)

Initializes an AppFrame with the following components

func (AppFrame) Init

func (m AppFrame) Init() tea.Cmd

Call the Init functions of all the child components (including the actionBar, which will need it for the cursor to blink)

func (AppFrame) Update

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

func (AppFrame) View

func (m AppFrame) View() string