bublog

README

Logging component for bubbletea TUI framework

If you want to duplicate logs of your application to TUI and any other number of io.Writers. To integrate it to slog:

	slog.SetDefault(slog.New(slog.NewTextHandler(m)))

Documentation

Overview

Package bublog to show your logs in TUI and duplicate them to other places.

Index

• func SplitLine(line []rune, maxWidth int) [][]rune
• type KeyMap
  • func DefaultKeyMap() *KeyMap
• type Model
  • func NewModel(initialText string, additionalWriters ...io.Writer) *Model
  • func (m *Model) Init() tea.Cmd
  • func (m *Model) SetSize(sizes ...int)
  • func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m *Model) View() string
  • func (m *Model) Write(p []byte) (n int, err error)
• type TextViewer
  • func NewTextViewer(text []rune) *TextViewer
  • func (t *TextViewer) AppendToText(s string)
  • func (t *TextViewer) Recalculate()
  • func (t *TextViewer) ScrollDown() bool
  • func (t *TextViewer) ScrollTextDown() bool
  • func (t *TextViewer) ScrollTextUp() bool
  • func (t *TextViewer) ScrollUp() bool
  • func (t *TextViewer) SetHeight(h int)
  • func (t *TextViewer) SetWidth(w int)
  • func (t *TextViewer) SwitchStickToBottom()
  • func (t *TextViewer) View() [][]rune

Functions

func SplitLine

func SplitLine(line []rune, maxWidth int) [][]rune

SplitLine fits an array of []rune into several with max length of maxWidth.

Types

type KeyMap

type KeyMap struct {
	StickToBottom key.Binding
	ScrollDown    key.Binding
	ScrollUp      key.Binding
}

func DefaultKeyMap

func DefaultKeyMap() *KeyMap

type Model

type Model struct {
	AdditionalWriters []io.Writer
	Viewer            *TextViewer
	KeyMap            *KeyMap
}

func NewModel

func NewModel(initialText string, additionalWriters ...io.Writer) *Model

func (*Model) Init

func (m *Model) Init() tea.Cmd

func (*Model) SetSize

func (m *Model) SetSize(sizes ...int)

SetSize accepts up to two arguments. First fill be Width, second - Height.

func (*Model) Update

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

func (*Model) View

func (m *Model) View() string

func (*Model) Write

func (m *Model) Write(p []byte) (n int, err error)

Write allows using this model as an argument to logging tools.

type TextViewer

type TextViewer struct {
	// Inner representation of Text is already split by /n to make it easier to navigate.
	Text [][]rune

	// DisplayText has several layer structure.
	// Upper level represents a complete /n line from Text.
	// Level below is a sublines - several strings gotten from original to fix into Width.
	// Last level is rune representation of a string.
	DisplayText [][][]rune

	Width  int
	Height int

	// LineInText shows from which line current DisplayText is rendered.
	LineInText           int
	SubLineInDisplayText int

	StickedToBottom bool
}

TextViewer takes Text and allows to have only a portion of it being displayed in given Private.Width and Private.Height

func NewTextViewer

func NewTextViewer(text []rune) *TextViewer

func (*TextViewer) AppendToText

func (t *TextViewer) AppendToText(s string)

func (*TextViewer) Recalculate

func (t *TextViewer) Recalculate()

func (*TextViewer) ScrollDown

func (t *TextViewer) ScrollDown() bool

func (*TextViewer) ScrollTextDown

func (t *TextViewer) ScrollTextDown() bool

func (*TextViewer) ScrollTextUp

func (t *TextViewer) ScrollTextUp() bool

func (*TextViewer) ScrollUp

func (t *TextViewer) ScrollUp() bool

func (*TextViewer) SetHeight

func (t *TextViewer) SetHeight(h int)

func (*TextViewer) SetWidth

func (t *TextViewer) SetWidth(w int)

func (*TextViewer) SwitchStickToBottom

func (t *TextViewer) SwitchStickToBottom()

func (*TextViewer) View

func (t *TextViewer) View() [][]rune