base

Documentation

Index

• func Back() tea.Msg
• func Err(err error) tea.Cmd
• func PushState(state State) tea.Cmd
• type Model
• type MsgBack
• type Size
• type State
• type Styles
  • func DefaultStyles() Styles
• type Title

Functions

func Back

func Back() tea.Msg

func Err

func Err(err error) tea.Cmd

func PushState

func PushState(state State) tea.Cmd

Types

type Model

type Model interface {
	tea.Model

	Context() context.Context
	AvailableSize() Size
}

type MsgBack

type MsgBack struct{}

type Size

type Size struct {
	Width, Height int
}

type State

type State interface {
	Intermediate() bool
	Backable() bool

	KeyMap() help.KeyMap

	Title() Title
	Subtitle() string
	Status() string

	Resize(size Size) tea.Cmd

	Update(model Model, msg tea.Msg) tea.Cmd
	View(model Model) string
	Init(model Model) tea.Cmd
}

type Styles

type Styles struct {
	Title,
	TitleBar,
	Subtitle,
	HelpBar,
	Selection lipgloss.Style
}

func DefaultStyles

func DefaultStyles() Styles

type Title

type Title struct {
	Text                   string
	Background, Foreground lipgloss.Color
}