util

Documentation

Index

• func AlertError(msg string) tea.Cmd
• func AlertInfo(msg string) tea.Cmd
• func AlertPersist(alertType, msg string) tea.Cmd
• func AlertWarn(msg string) tea.Cmd
• func Clamp(v, low, high int) int
• func CmdHandler(msg tea.Msg) tea.Cmd
• func ReportError(err error) tea.Cmd
• func ReportInfo(info string) tea.Cmd
• func ReportWarn(warn string) tea.Cmd
• type AlertMsg
• type ClearStatusMsg
• type InfoMsg
• type InfoType

Functions

func AlertError

func AlertError(msg string) tea.Cmd

AlertError creates a bubbleup error overlay alert.

func AlertInfo

func AlertInfo(msg string) tea.Cmd

AlertInfo creates a bubbleup info overlay alert.

func AlertPersist

func AlertPersist(alertType, msg string) tea.Cmd

AlertPersist creates a persistent bubbleup alert that stays until Esc is pressed.

func AlertWarn

func AlertWarn(msg string) tea.Cmd

AlertWarn creates a bubbleup warning overlay alert.

func Clamp

func Clamp(v, low, high int) int

func CmdHandler

func CmdHandler(msg tea.Msg) tea.Cmd

func ReportError

func ReportError(err error) tea.Cmd

func ReportInfo

func ReportInfo(info string) tea.Cmd

func ReportWarn

func ReportWarn(warn string) tea.Cmd

Types

type AlertMsg

type AlertMsg struct {
	Type    string // bubbleup alert key: "Info", "Warn", "Error"
	Msg     string
	Persist bool // if true, alert stays until dismissed with Esc
}

AlertMsg triggers a bubbleup overlay alert instead of the status bar.

type ClearStatusMsg

type ClearStatusMsg struct{}

type InfoMsg

type InfoMsg struct {
	Type InfoType
	Msg  string
	TTL  time.Duration
}

type InfoType

type InfoType int

const (
	InfoTypeInfo InfoType = iota
	InfoTypeWarn
	InfoTypeError
)