statusbar

Documentation

Index

• func NewErrCmd(description string) tea.Cmd
• func NewErrCmds(descriptions ...string) []tea.Cmd
• func NewHelpCmd(h [][]key.Binding) tea.Cmd
• func NewMessageCmd(message string, opts ...SetMessageOpts) tea.Cmd
• func NewTitleCmd(title string, opts ...SetTitleOpts) tea.Cmd
• type Model
  • func New(title string) Model
  • func (m Model) FullHelp() [][]key.Binding
  • func (m Model) GetHeight() int
  • func (m Model) Init() tea.Cmd
  • func (m *Model) IsActive() bool
  • func (m Model) IsInitialized() bool
  • func (m *Model) SetActive(active bool)
  • func (m *Model) SetWidth(width int)
  • func (m Model) ShortHelp() []key.Binding
  • func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)
  • func (m Model) View() string
• type SetErrMsg
  • func NewErrMsg(description string) SetErrMsg
  • func (e SetErrMsg) Error() string
• type SetHelpMsg
  • func NewHelpMsg(h [][]key.Binding) SetHelpMsg
• type SetMessageMsg
  • func NewMessageMsg(message string, opts ...SetMessageOpts) SetMessageMsg
• type SetMessageOpts
  • func WithMessageTimeout(timeout int) SetMessageOpts
• type SetTitleMsg
  • func NewTitleMsg(title string, opts ...SetTitleOpts) SetTitleMsg
• type SetTitleOpts
  • func WithTitleBackground(bg lipgloss.TerminalColor) SetTitleOpts
  • func WithTitleForeground(fg lipgloss.TerminalColor) SetTitleOpts

Functions

func NewErrCmd

func NewErrCmd(description string) tea.Cmd

func NewErrCmds

func NewErrCmds(descriptions ...string) []tea.Cmd

func NewHelpCmd

func NewHelpCmd(h [][]key.Binding) tea.Cmd

func NewMessageCmd

func NewMessageCmd(message string, opts ...SetMessageOpts) tea.Cmd

func NewTitleCmd

func NewTitleCmd(title string, opts ...SetTitleOpts) tea.Cmd

Types

type Model

type Model struct {
	Title           string
	TitleForeground lipgloss.TerminalColor
	TitleBackground lipgloss.TerminalColor
	// contains filtered or unexported fields
}

func New

func New(title string) Model

func (Model) FullHelp

func (m Model) FullHelp() [][]key.Binding

func (Model) GetHeight

func (m Model) GetHeight() int

func (Model) Init

func (m Model) Init() tea.Cmd

func (*Model) IsActive

func (m *Model) IsActive() bool

func (Model) IsInitialized

func (m Model) IsInitialized() bool

func (*Model) SetActive

func (m *Model) SetActive(active bool)

func (*Model) SetWidth

func (m *Model) SetWidth(width int)

func (Model) ShortHelp

func (m Model) ShortHelp() []key.Binding

func (Model) Update

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

func (Model) View

func (m Model) View() string

type SetErrMsg

type SetErrMsg struct {
	Description string
}

func NewErrMsg

func NewErrMsg(description string) SetErrMsg

func (SetErrMsg) Error

func (e SetErrMsg) Error() string

type SetHelpMsg

type SetHelpMsg [][]key.Binding

func NewHelpMsg

func NewHelpMsg(h [][]key.Binding) SetHelpMsg

type SetMessageMsg

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

func NewMessageMsg

func NewMessageMsg(message string, opts ...SetMessageOpts) SetMessageMsg

type SetMessageOpts

type SetMessageOpts func(*SetMessageMsg)

func WithMessageTimeout

func WithMessageTimeout(timeout int) SetMessageOpts

type SetTitleMsg

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

func NewTitleMsg

func NewTitleMsg(title string, opts ...SetTitleOpts) SetTitleMsg

type SetTitleOpts

type SetTitleOpts func(*SetTitleMsg)

func WithTitleBackground

func WithTitleBackground(bg lipgloss.TerminalColor) SetTitleOpts

func WithTitleForeground

func WithTitleForeground(fg lipgloss.TerminalColor) SetTitleOpts