statusbar

Documentation

Overview

Package statusbar provides an statusbar bubble which can render four different status sections

Index

• Constants
• type ColorConfig
• type Model
  • func New(...) Model
  • func (m *Model) SetColors(...)
  • func (m *Model) SetContent(firstColumn, secondColumn, thirdColumn, fourthColumn string)
  • func (m *Model) SetSize(width int)
  • func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)
  • func (m Model) View() string

Constants

const Height = 1

Height represents the height of the statusbar.

Types

type ColorConfig

type ColorConfig struct {
	Foreground lipgloss.AdaptiveColor
	Background lipgloss.AdaptiveColor
}

ColorConfig represents the the foreground and background color configuration.

type Model

type Model struct {
	Width              int
	Height             int
	FirstColumn        string
	SecondColumn       string
	ThirdColumn        string
	FourthColumn       string
	FirstColumnColors  ColorConfig
	SecondColumnColors ColorConfig
	ThirdColumnColors  ColorConfig
	FourthColumnColors ColorConfig
}

Model represents the properties of the statusbar.

func New

func New(
	firstColumnColors,
	secondColumnColors,
	thirdColumnColors,
	fourthColumnColors ColorConfig,
) Model

New creates a new instance of the statusbar.

func (*Model) SetColors

func (m *Model) SetColors(
	firstColumnColors,
	secondColumnColors,
	thirdColumnColors,
	fourthColumnColors ColorConfig,
)

SetColors sets the colors of the 4 columns.

func (*Model) SetContent

func (m *Model) SetContent(firstColumn, secondColumn, thirdColumn, fourthColumn string)

SetContent sets the content of the statusbar.

func (*Model) SetSize

func (m *Model) SetSize(width int)

SetSize sets the width of the statusbar.

func (Model) Update

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

Update updates the UI of the statusbar.

func (Model) View

func (m Model) View() string

View returns a string representation of the statusbar.