devtui

README

devtui

interactive terminal user interface focused on developing applications

Documentation

Index

• func NewMessageTracker() *messageTracker
• type AsyncMessageMsg
• type ColorStyle
• type DevTUI
  • func DefaultTUIForTest(LogToFile func(messageErr any)) *DevTUI
  • func NewTUI(c *TuiConfig) *DevTUI
  • func (h *DevTUI) ContentView() string
  • func (h *DevTUI) HandleKeyboard(msg tea.KeyMsg) (bool, tea.Cmd)
  • func (h *DevTUI) Init() tea.Cmd
  • func (h *DevTUI) InitTUI(args ...any)
  • func (t *DevTUI) NewTabSection(title string, fhAdapters ...fieldHandlerAdapter) *tabSection
  • func (h *DevTUI) Print(messages ...any)
  • func (h *DevTUI) ProcessFieldValueChange(field *fieldHandler, newValue string)
  • func (t *DevTUI) ReturnFocus() error
  • func (h *DevTUI) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (h *DevTUI) View() string
• type IDGenerator
  • func NewIDGenerator() IDGenerator
• type MessageID
• type MessageUpdate
• type TuiConfig

Functions

func NewMessageTracker

func NewMessageTracker() *messageTracker

NewMessageTracker creates a new message tracker

Types

type AsyncMessageMsg

type AsyncMessageMsg tuiMessage

AsyncMessageMsg is a message from an async field handler

type ColorStyle

type ColorStyle struct {
	ForeGround string // eg: #F4F4F4
	Background string // eg: #000000
	Highlight  string // eg: #FF6600
	Lowlight   string // eg: #666666
}

type DevTUI

type DevTUI struct {
	*TuiConfig
	// contains filtered or unexported fields
}

DevTUI mantiene el estado de la aplicación

func DefaultTUIForTest

func DefaultTUIForTest(LogToFile func(messageErr any)) *DevTUI

NewDefaultTUI creates a DevTUI instance with basic default configuration useful for unit tests and for quick initialization in real applications

func NewTUI

func NewTUI(c *TuiConfig) *DevTUI

func (*DevTUI) ContentView

func (h *DevTUI) ContentView() string

ContentView renderiza los mensajes para una sección de contenido

func (*DevTUI) HandleKeyboard

func (h *DevTUI) HandleKeyboard(msg tea.KeyMsg) (bool, tea.Cmd)

HandleKeyboard processes keyboard input and updates the model state returns whether the update function should continue processing or return early

func (*DevTUI) Init

func (h *DevTUI) Init() tea.Cmd

Init initializes the terminal UI application.

func (*DevTUI) InitTUI

func (h *DevTUI) InitTUI(args ...any)

InitTUI initializes and runs the terminal UI application.

It accepts optional variadic arguments of any type. If a *sync.WaitGroup is provided among these arguments, InitTUI will call its Done() method before returning.

The method runs the UI using the internal tea engine, and handles any errors that may occur during execution. If an error occurs, it will be displayed on the console and the application will wait for user input before exiting.

Parameters:

• args ...any: Optional arguments. Can include a *sync.WaitGroup for synchronization.

func (*DevTUI) NewTabSection

func (t *DevTUI) NewTabSection(title string, fhAdapters ...fieldHandlerAdapter) *tabSection

NewTabSection creates a new tab section

func (*DevTUI) Print

func (h *DevTUI) Print(messages ...any)

Print sends a normal Name or error to the tui in current tab

func (*DevTUI) ProcessFieldValueChange

func (h *DevTUI) ProcessFieldValueChange(field *fieldHandler, newValue string)

ProcessFieldValueChange handles field value changes

func (*DevTUI) ReturnFocus

func (t *DevTUI) ReturnFocus() error

func (*DevTUI) Update

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

Update maneja las actualizaciones del estado

func (*DevTUI) View

func (h *DevTUI) View() string

type IDGenerator

type IDGenerator interface {
	GetNewID() string
}

IDGenerator represents a unique ID generator

func NewIDGenerator

func NewIDGenerator() IDGenerator

Use the existing UnixID as an IDGenerator implementation

type MessageID

type MessageID string

Identificador único para mensajes

type MessageUpdate

type MessageUpdate struct {
	Content string
	Type    messagetype.Type
}

Actualización de estado para mensajes

type TuiConfig

type TuiConfig struct {
	AppName       string    // app name eg: "MyApp"
	TabIndexStart int       // is the index of the tab section to start
	ExitChan      chan bool //  global chan to close app
	Color         *ColorStyle

	LogToFile func(messageErr any) // function to write log error
}