frame

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 6, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Frame

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

func New

func New() *Frame

func (*Frame) AppendModel

func (f *Frame) AppendModel(uiElement tea.Model)

func (Frame) Footer

func (f Frame) Footer() io.ReadWriter

func (Frame) Init

func (f Frame) Init() tea.Cmd

func (*Frame) ShowFooter

func (f *Frame) ShowFooter(set bool)

func (*Frame) TruncateFooter

func (f *Frame) TruncateFooter(set bool)

func (*Frame) Update

func (f *Frame) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (Frame) View

func (f Frame) View() string

type ImprintableElement

type ImprintableElement interface {
	ShouldImprint() bool
}

ImprintableElement is a special case of a TerminalElement, where the element is removed from the model state after a printing the model state as a trail behind the current model and removing the element on the next update

type TerminalElement

type TerminalElement interface {
	IsAlive() bool
}

TerminalElement allows UI elements to have a lifecycle, where at the end of the lifecycle the element is removed from the model state entirely

type VisibleElement

type VisibleElement interface {
	IsHidden() bool
}

VisibleElement allows UI elements to be conditionally hidden, but still present in the model state

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL