module

Documentation

Index

• type ImagePlacement
• type ImagePlacer
• type Module

Types

type ImagePlacement

type ImagePlacement struct {
	Row    int    // row offset within the module content area
	Col    int    // col offset within the module content area
	Escape string // kitty graphics escape to display the image (e.g. a=p,i=ID)
}

ImagePlacement describes an image to render at a specific screen position. The Row and Col are relative to the module's content area; the layout engine converts them to absolute terminal coordinates.

type ImagePlacer

type ImagePlacer interface {
	ImagePlacements() []ImagePlacement
}

ImagePlacer is an optional interface modules can implement to render images via the Kitty graphics protocol. The layout engine will call ImagePlacements() after View() and position the images on screen.

type Module

type Module interface {
	// Name returns the display name shown in the module's title bar.
	Name() string

	// Init returns the initial command (e.g. first data fetch).
	Init() tea.Cmd

	// Update handles messages. Return nil cmd if the message isn't relevant.
	Update(msg tea.Msg) tea.Cmd

	// View renders the module content (without the border/title — the
	// framework wraps it). width and height are the available content area.
	View(width, height int) string

	// MinSize returns the preferred minimum width and height (content area,
	// excluding border/padding). The layout engine uses these as hints.
	MinSize() (width, height int)
}

Module is the interface every Lattice module must implement. Modules are self-contained: they manage their own state, fetching, and rendering. The framework handles layout and lifecycle.

External modules should implement this interface and register themselves in their init() function using registry.Register().