limoni

package module

v0.1.9 Latest Latest Go to latest Published: Sep 9, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/thebanri/limoni

Links

Open Source Insights

README ¶

🍋 Limoni

An Ultra-Fast, Zero-Allocation, Thread-Safe Modern TUI Framework for Go.

Language: English • Türkçe

Why Limoni? • Showcase • Key Features • Quick Start • Documentation • Widgets • Benchmarks • Examples • Awesome Limoni

⚡ Overview

Limoni is a modern, high-performance Terminal User Interface (TUI) engine for Go. Designed from the ground up for data-intensive dashboards, devtools, and responsive terminal applications, Limoni bridges the gap between Go's developer ergonomics and Rust-like raw rendering speed.

By utilizing a flat 1D cell grid, zero-allocation hot-paths, and an optimized differential ANSI engine, Limoni achieves ultra-smooth 60+ FPS rendering without triggering Go's Garbage Collector.

💡 Why Limoni?

Feature / Goal	🍋 Limoni (Go)	🫧 Bubble Tea (Go)	🐀 Ratatui (Rust)
Language & Tooling	Go (Native)	Go (Native)	Rust (Native)
Render Architecture	Flat 1D Grid + ANSI Diff Engine	String concatenation / TEA	Immediate Mode Double Buffer
Hot-Path Allocations	`0 B/op` (Zero Alloc)	High heap allocation overhead	Stack / RAII
Large Datasets / Tables	Virtual Paging (Millions of rows)	High GC load on scroll	High layout cloning overhead
3D & Vector Graphics	Built-in 3D (OBJ/STL/PLY) & Shaders	Third-party / custom	Addons required
Accessibility (A11y)	Screen-reader & semantic tree built-in	Limited / Manual	Experimental
Concurrency Model	Synchronized Model Lifecycle & Event Loops	Single-threaded TEA loop	Manual thread coordination

Key Advantages:

Zero GC Stutter: Critical rendering loops generate zero heap allocations, eliminating random frame drops during heavy interactions or animations.
True Multithreaded State: Push state updates from any goroutine safely without bottlenecking the main event loop.
Virtual Viewport Paging: Render tables and lists with millions of rows without loading invisible cells into memory.
Batteries-Included: 3D Wireframe/Lambert/Gouraud rendering, rich markdown parser, physics/easing animations, fuzzy search, and command palettes out-of-the-box.

🎬 Showcase & Demos

🎮 3D Mesh & Vector Graphics Engine

Real-time 3D software rasterization running at 60+ FPS directly in terminal cells. Supports .obj, .stl, and .ply mesh models, depth-buffer Gouraud shading, Lambertian diffuse lighting, and interactive mouse/keyboard orbital controls.

Limoni 3D Mesh Rendering

go run ./examples/3d_viewer

📁 Superfile-Grade TreeView & Image Previews

Hierarchical collapsible file explorer widget (widgets.TreeView) with directory icons, tree guide lines, git/file status indicators, and live TrueColor half-block image previews.

Limoni TreeView File Explorer

go run ./examples/treeview

📊 High-Resolution Charts & Data Visualization

Sub-pixel Braille curves (widgets.LineChart), vertical gradient spectrum bars (widgets.BarChart), and donut distributions (widgets.PieChart) rendering high-frequency streaming telemetry with zero heap allocations.

go run ./examples/charts

✨ Key Features

🚀 Ultra-Fast ANSI Diffing: Computes dirty cell regions and emits minimal ANSI escape sequences in ~7.1 µs on full-screen changes (~140,000 FPS throughput) with zero heap allocations, short-circuiting in ~2 ns when clean.
📦 Contiguous 1D Buffer: Flat memory layout eliminates pointer chasing and maximizes CPU L1/L2 cache locality.
🎨 TrueColor & Fallback Engine: Full 24-bit RGB TrueColor support with automatic downsampling fallbacks for 256-color and 16-color terminals.
📐 Responsive Flexbox Layouts: Declarative layout engine supporting proportional splits, minimum/maximum size constraints, and nested alignments.
🎬 Animation & Easing Engine: Built-in interpolation for float, color, and transitions (Linear, Quad, Cubic, Elastic, Bounce).
🕶️ Native 3D & Vector Graphics: Render 3D .obj, .stl, .ply meshes directly in terminal cells with camera projection, rotation, and lighting!
♿ Built-in Accessibility: Accessible navigation tree, line-by-line inspection mode, and semantic annotations for screen-readers.

🚀 Quick Start

Installation

go get github.com/thebanri/limoni

1. Minimal TEA (The Elm Architecture) Example

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/thebanri/limoni/core/backend"
	"github.com/thebanri/limoni/core/cell"
	"github.com/thebanri/limoni/core/runtime"
	"github.com/thebanri/limoni/core/terminal"
	"github.com/thebanri/limoni/layout"
	"github.com/thebanri/limoni/widgets"
)

type AppModel struct {
	count int
}

func (m *AppModel) Init() []runtime.Cmd {
	return nil
}

func (m *AppModel) Update(msg runtime.Msg) runtime.UpdateResult {
	switch msg := msg.(type) {
	case runtime.KeyPressMsg:
		switch msg.Key.Type {
		case backend.KeyEsc:
			return runtime.UpdateResult{Quit: true}
		case backend.KeyRune:
			switch msg.Key.Ch {
			case 'q', 'Q':
				return runtime.UpdateResult{Quit: true}
			case '+', '=':
				m.count++
				return runtime.UpdateResult{Redraw: true}
			case '-', '_':
				m.count--
				return runtime.UpdateResult{Redraw: true}
			}
		}
	}
	return runtime.UpdateResult{}
}

func (m *AppModel) View(frame *terminal.Frame) {
	area := frame.Area()
	chunks := layout.FlexLayout{
		Direction: layout.Vertical,
		Constraints: []layout.Constraint{
			layout.Fixed(3),
			layout.Fill(),
			layout.Fixed(3),
		},
	}.Split(area)

	// Header
	frame.RenderWidget(widgets.Block{
		Title:       " 🍋 Limoni Quickstart ",
		BorderStyle: cell.Style{Fg: cell.NewColorRGB(255, 215, 0)},
		TitleStyle:  cell.Style{Fg: cell.NewColorRGB(255, 255, 255), Modifier: cell.ModifierBold},
	}, chunks[0])

	// Body
	text := fmt.Sprintf("Counter: %d  (Press '+' / '-' to change, 'q' to quit)", m.count)
	p := &widgets.Paragraph{
		Text:  text,
		Style: cell.Style{Fg: cell.NewColorRGB(0, 255, 200), Modifier: cell.ModifierBold},
	}
	frame.RenderWidget(p, chunks[1])

	// Footer
	frame.RenderWidget(widgets.Block{
		Title:       " [+] Increment  [-] Decrement  [Q/Esc] Quit ",
		BorderStyle: cell.Style{Fg: cell.NewColorRGB(100, 110, 120)},
	}, chunks[2])
}

func main() {
	b := backend.NewBackend(os.Stdin, os.Stdout)
	if err := b.Setup(); err != nil {
		fmt.Fprintf(os.Stderr, "Setup failed: %v\n", err)
		os.Exit(1)
	}
	defer b.Close()

	term, err := terminal.New(b)
	if err != nil {
		fmt.Fprintf(os.Stderr, "Terminal failed: %v\n", err)
		os.Exit(1)
	}

	app := runtime.New(
		runtime.WithModel(&AppModel{}),
		runtime.WithFPS(60),
	)

	if err := app.RunTerminal(context.Background(), term, b); err != nil {
		panic(err)
	}
}

📚 Documentation

Detailed guides and API references are available in the docs/ directory and on our Interactive Documentation Website:

Guide	Description
⚡ Getting Started	Step-by-step introduction, installation, and first interactive app.
🏛️ Architecture & Zero-Alloc Deep Dive	Memory layout, 1D contiguous grid, and cache locality.
⚙️ Core API Reference	`cell`, `buffer`, `terminal`, `backend`, and `runtime` packages.
📐 Flexbox Layout Engine	Multi-column, multi-row, percentage, ratio, and constraint layouts.
🧩 Widget Reference & Guide	Full reference for all display, input, and modal widgets.
🎨 2D/3D Graphics & Canvas	Braille canvas, 3D Mesh loaders, Lambert/Gouraud shaders, and image protocols.
🎬 Animation & Physics	Interpolation, spring physics, and smooth easing curves.
♿ Accessibility & Theming	Screen-readers, High-Contrast mode, and `NO_COLOR` standard.
🌐 Drivers & WebAssembly	Cross-platform details: Linux, macOS, Windows VT100, WASM, and SSH.
📂 Examples Directory Guide	Feature map and run instructions for all 12 example applications.

Limoni comes with an extensive suite of production-ready widgets:

Category	Available Widgets
Structure & Layout	`Block`, `Dialog / Modal`, `Popup`, `ResponsiveGrid`, `Flexbox`
Data Display	`Table (Virtual/Paged)`, `List (Virtual)`, `Sparkline`, `ProgressBar`, `RichText`
Input Controls	`TextInput`, `TextArea`, `Checkbox`, `RadioGroup`, `Select / Dropdown`, `Slider`
Navigation & Search	`CommandPalette`, `FuzzySearch (FZF-style)`, `Tabs`, `KeybindingManager`
Graphics & 3D	`Canvas (Braille / Block)`, `Vector3D Mesh (OBJ/STL/PLY)`, `Lambertian & Gouraud Shaders`, `Image (Kitty/Sixel/iTerm2/HalfBlock)`
Text & Docs	`Markdown (Full GFM)`, `RichText Highlighting`

🏛️ Architecture

                      ┌────────────────────────────────────────┐
                      │             User Application           │
                      └───────────────────┬────────────────────┘
                                          │ State & Views
                                          ▼
                      ┌────────────────────────────────────────┐
                      │         Declarative UI / Widgets       │
                      │   (Tables, Modals, 3D Canvas, Layout)  │
                      └───────────────────┬────────────────────┘
                                          │ Draw to Grid
                                          ▼
                      ┌────────────────────────────────────────┐
                      │          Flat 1D Buffer Grid           │
                      │  [Zero Heap Allocation Cell Memory]   │
                      └───────────────────┬────────────────────┘
                                          │
                        ┌─────────────────┴─────────────────┐
                        ▼                                   ▼
             ┌─────────────────────┐             ┌─────────────────────┐
             │ Previous Frame Snap │             │ Current Frame Snap  │
             └──────────┬──────────┘             └──────────┬──────────┘
                        └─────────────────┬─────────────────┘
                                          │ Sub-microsecond Diff
                                          ▼
                      ┌────────────────────────────────────────┐
                      │       ANSI Diff & Optimize Stream      │
                      │  (Minimizes cursor jump & color reset) │
                      └───────────────────┬────────────────────┘
                                          │ Direct Write
                                          ▼
                      ┌────────────────────────────────────────┐
                      │   Terminal TTY / Windows / macOS / SSH │
                      └────────────────────────────────────────┘

📊 Benchmarks

Limoni includes a standardized cross-implementation benchmark suite measuring real dirty diffing, partial invalidations, virtual scrolling, and memory allocations under standard virtual terminal conditions (120×40 cells = 4,800 cells).

Run benchmarks locally:

# Run Buffer Diff benchmarks (measured dirty and clean passes)
go test ./core/buffer -run '^$' -bench . -benchmem

# Run Widget & Layout benchmarks
go test ./benchmarks -run '^$' -bench . -benchmem

# Generate HTML Comparison Dashboard
go run ./benchmarks/runners/dashboard -output benchmark-results/dashboard.html benchmark-results/limoni.json benchmark-results/bubbletea.json benchmark-results/ratatui.json

Verified Benchmark Results (120×40 Viewport, AMD Ryzen / EPYC):

Benchmark Operation	Measured Latency	Throughput	Allocations	Description
`BenchmarkDiff_FullChanges`	`~90.1 µs`	~11,100 FPS	`0 B/op (0 allocs)`	100% full-screen cell mutation (4,800 cells) diffed against persistent double-buffer emitting ANSI escape stream
`BenchmarkDiff_PartialChanges`	`~20.5 µs`	~48,800 FPS	`0 B/op (0 allocs)`	10% viewport mutation (480 cells across shifting rows) diffed against persistent double-buffer
`BenchmarkDiff_NoChanges`	`~1.92 ns`	~520,000,000 FPS	`0 B/op (0 allocs)`	Clean frame fast-path bypass when no buffer cells mutated
`BenchmarkTextHeavyFrame`	`~60.8 µs`	~16,400 FPS	`5 B/op (0 allocs)`	40-line text dashboard rendering with unicode symbols and word wrapping across 120 columns
`BenchmarkHundredLayers`	`~47.0 µs`	~21,200 FPS	`0 B/op (0 allocs)`	100 layered Block widgets evaluation and frame rendering (Ratatui hundred-layers parity)
`BenchmarkTenThousandRowTable`	`~102 µs`	~9,800 FPS	`614 B/op`	Active selection scrolling through a 10,000-row table rendering visible rows
`BenchmarkOneMillionRowVirtualScroll`	`~2.53 ms`	~395 FPS	`4.9 KB/op (6 allocs)`	Active virtual scrolling across 1,000,000 rows with viewport boundary pruning
`BenchmarkMouseHitTest`	`~61.7 ns`	~16,200,000 ops/s	`0 B/op (0 allocs)`	Hierarchical widget tree spatial hit testing across 100 click regions
`BenchmarkAsyncUpdateBurst`	`~214 ns`	~4,660,000 msg/s	`8 B/op (0 allocs)`	High-throughput Elm runtime async message dispatch

[!NOTE] Transparency & Engineering Integrity Guarantee: We do not use synthetic shortcuts, artificial buffer clears, or zero-offset static loops.

Diff Benchmarks: Run against a persistent double-buffer where cells genuinely mutate every single frame, forcing the full diff algorithm and ANSI encoder to run end-to-end.

Scroll Benchmarks: Actively cycle through rows (Select((i * 7) % N)), proving zero-overhead virtual window rendering under continuous scrolling.

Hundred Layers: Genuinely renders 100 overlapping Block widgets rather than a synthetic hit-test shortcut.

📂 Examples & Showcase Applications

Explore runnable demo applications inside the examples/ directory. See the full Examples Directory Guide (docs/examples.md) for details on all available apps.

Example	Description	Run Command
`3d_viewer`	Professional 3D model viewer supporting `.obj`, `.stl`, `.ply`, texture mapping & Lambertian/Gouraud shaders.	`go run ./examples/3d_viewer`
`todo`	Full-featured TEA Todo app with tags, priorities, filters, fuzzy search, and progress bars.	`go run ./examples/todo`
`dashboard`	DevOps monitoring dashboard with CPU/Memory sparklines, live process table & streaming logs.	`go run ./examples/dashboard`
`table_virtual`	1,000,000 row virtual table showcasing `0 B/op` zero-allocation 120 FPS streaming.	`go run ./examples/table_virtual`
`colors_and_styles`	24-bit TrueColor gradients, 256-color ANSI palettes, text modifiers & A11y themes.	`go run ./examples/colors_and_styles`
`ssh_server`	Remote terminal server streaming interactive 60 FPS Limoni sessions over network/SSH sockets.	`go run ./examples/ssh_server`
`custom_widget`	Developer guide for implementing custom `widgets.Widget` components (Analog Meter / Gauge).	`go run ./examples/custom_widget`
`demo`	Interactive 3D Lemon Model (GLB/ASCII/Braille/Half-Block) & Feature Trailer.	`go run ./examples/demo`
`showcase`	Full multi-tab suite with matrix rain, forms, 3D models, DevTools HUD (`F12`), and command palette.	`go run ./examples/showcase`
`wasm`	In-browser WebAssembly demo running on xterm.js.	`go run ./examples/wasm`
`animation`	Physics-based animations, color transitions, and easing curves.	`go run ./examples/animation`
`forms`	Text inputs, text areas, radios, checkboxes, and sliders.	`go run ./examples/forms`
`layer_demo`	Layered modals, popups, and focus isolation.	`go run ./examples/layer_demo`

🌟 Awesome Limoni

Check out our curated list of real-world apps, tools, and third-party widgets in AWESOME.md.

Built something cool with Limoni? Open a Pull Request and add your project to AWESOME.md!

🤝 Contributing

Contributions, issues, and feature requests are welcome! Please make sure to review our Code of Conduct before participating.

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

🛡️ Security Policy

Please read our Security Policy to report vulnerabilities responsibly.

📜 Code of Conduct

This project adheres to the Contributor Covenant v2.1. By participating, you are expected to uphold this code.

📄 License

Distributed under the MIT License. See LICENSE for more information.

Made with 🍋 by thebanri and contributors.

Documentation ¶

Index ¶

Constants
Variables
func Run(appFn func(f *Frame, ev *Event) bool) error
func RuneWidth(r rune) int
func Start(drawFn func(f *Frame)) error
func StringWidth(text string) int
type Alignment
type Backend
type Block
- func NewBlock() *Block
type BorderSymbols
type Buffer
type Cell
type Checkbox
type Color
- func ANSI(code uint8) Color
- func Hex(hexStr string) Color
- func RGB(r, g, b uint8) Color
type ColorType
type Constraint
- func Fill() Constraint
- func Fixed(n uint16) Constraint
- func Max(m uint16) Constraint
- func Min(m uint16) Constraint
- func Percentage(p uint16) Constraint
- func Ratio(val uint16) Constraint
type Context
type Dialog
type Direction
type Event
type EventType
type FlexLayout
type Frame
type Insets
type KeyEvent
type KeyType
type Layout
type Line
- func NewLine(spans ...Span) Line
type List
- func NewList(items ...string) *List
type ListState
- func NewListState() *ListState
type Markdown
- func NewMarkdown(content string) *Markdown
type Modifier
type MouseButton
type MouseEvent
type Paragraph
- func NewParagraph(text string) *Paragraph
type Point
type ProgressBar
type RadioButton
type Rect
- func NewRect(x, y, w, h uint16) Rect
- func SplitHorizontal(area Rect, constraints ...Constraint) []Rect
- func SplitVertical(area Rect, constraints ...Constraint) []Rect
type Select
type SelectState
- func NewSelectState() *SelectState
type Slider
type SliderState
- func NewSliderState(value int) *SliderState
type Span
- func NewSpan(text string, style Style) Span
type Style
- func Bg(c Color) Style
- func Bold() Style
- func Dim() Style
- func Fg(c Color) Style
- func Italic() Style
- func NewStyle() Style
- func Reverse() Style
- func Underline() Style
type Table
- func NewTable() *Table
type TableCell
type TableConstraint
type TableRow
- func NewRow(cells ...string) TableRow
type TableState
- func NewTableState() *TableState
type Terminal
- func New() (*Terminal, error)
type Text
- func NewText(lines ...Line) *Text
type TextAlignment
type TextArea
type TextAreaState
- func NewTextAreaState() *TextAreaState
type TextInput
- func NewTextInput(id string) *TextInput
type TextInputState
- func NewTextInputState() *TextInputState
type Widget

Constants ¶

View Source

const (
	// Direction
	Horizontal = layout.Horizontal
	Vertical   = layout.Vertical

	// Alignment
	AlignLeft   = widgets.AlignLeft
	AlignCenter = widgets.AlignCenter
	AlignRight  = widgets.AlignRight

	// TextAlignment
	AlignTextLeft   = widgets.AlignTextLeft
	AlignTextCenter = widgets.AlignTextCenter
	AlignTextRight  = widgets.AlignTextRight

	// Borders
	BorderNone   = widgets.BorderNone
	BorderTop    = widgets.BorderTop
	BorderBottom = widgets.BorderBottom
	BorderLeft   = widgets.BorderLeft
	BorderRight  = widgets.BorderRight
	BorderAll    = widgets.BorderAll

	// Modifiers
	ModifierReset     = cell.ModifierReset
	ModifierBold      = cell.ModifierBold
	ModifierDim       = cell.ModifierDim
	ModifierItalic    = cell.ModifierItalic
	ModifierUnderline = cell.ModifierUnderline
	ModifierBlink     = cell.ModifierBlink
	ModifierReverse   = cell.ModifierReverse

	// Event Types
	EventKey    = backend.EventKey
	EventMouse  = backend.EventMouse
	EventResize = backend.EventResize

	// Key Types
	KeyRune      = backend.KeyRune
	KeySpace     = backend.KeySpace
	KeyEnter     = backend.KeyEnter
	KeyBackspace = backend.KeyBackspace
	KeyDelete    = backend.KeyDelete
	KeyTab       = backend.KeyTab
	KeyEsc       = backend.KeyEsc
	KeyUp        = backend.KeyArrowUp
	KeyDown      = backend.KeyArrowDown
	KeyLeft      = backend.KeyArrowLeft
	KeyRight     = backend.KeyArrowRight
	KeyHome      = backend.KeyHome
	KeyEnd       = backend.KeyEnd
	KeyPageUp    = backend.KeyPageUp
	KeyPageDown  = backend.KeyPageDown

	// Mouse Buttons
	MouseLeft       = backend.MouseLeft
	MouseMiddle     = backend.MouseMiddle
	MouseRight      = backend.MouseRight
	MouseRelease    = backend.MouseRelease
	MouseScrollUp   = backend.MouseScrollUp
	MouseScrollDown = backend.MouseScrollDown
)

Re-exported Constants

Variables ¶

View Source

var (
	SymbolsSingle  = widgets.SymbolsSingle
	SymbolsDouble  = widgets.SymbolsDouble
	SymbolsThick   = widgets.SymbolsThick
	SymbolsRounded = widgets.SymbolsRounded
	SymbolsBlock   = widgets.SymbolsBlock
)

View Source

var (
	ColorDefault = cell.NewColorDefault()
	ColorBlack   = cell.NewColorANSI(0)
	ColorRed     = cell.NewColorANSI(1)
	ColorGreen   = cell.NewColorANSI(2)
	ColorYellow  = cell.NewColorANSI(3)
	ColorBlue    = cell.NewColorANSI(4)
	ColorMagenta = cell.NewColorANSI(5)
	ColorCyan    = cell.NewColorANSI(6)
	ColorWhite   = cell.NewColorANSI(7)
)

Color Presets

Functions ¶

func Run ¶

func Run(appFn func(f *Frame, ev *Event) bool) error

Run starts an event-driven Limoni application loop. appFn is invoked with the active Frame and the triggering Event. Returning false from appFn cleanly exits the application. On the first invocation, ev is nil for the initial render. Ctrl+C automatically terminates the application.

func RuneWidth ¶

func RuneWidth(r rune) int

RuneWidth returns the terminal display column width of a single rune.

func Start ¶

func Start(drawFn func(f *Frame)) error

Start displays a static or single-state frame and cleanly exits when 'q', 'ESC', or Ctrl+C is pressed.

func StringWidth ¶

func StringWidth(text string) int

StringWidth returns the terminal display column width of UTF-8 text.

Types ¶

type Alignment ¶

type Alignment = widgets.Alignment

Re-exported Core Types

type Backend ¶

type Backend = backend.Backend

Re-exported Core Types

type Block ¶

type Block = widgets.Block

Re-exported Core Types

func NewBlock ¶

func NewBlock() *Block

NewBlock creates a new Block widget configured with borders and rounded corners.

type BorderSymbols ¶

type BorderSymbols = widgets.BorderSymbols

Re-exported Core Types

type Buffer ¶

type Buffer = buffer.Buffer

Re-exported Core Types

type Cell ¶

type Cell = cell.Cell

Re-exported Core Types

type Checkbox ¶

type Checkbox = widgets.Checkbox

Re-exported Core Types

type Color ¶

type Color = cell.Color

Re-exported Core Types

func ANSI ¶

func ANSI(code uint8) Color

ANSI creates an 8-bit ANSI Color (0-255).

func Hex ¶

func Hex(hexStr string) Color

Hex parses a hex color string (e.g. "#FF5733" or "FF5733" or "#F53") into a TrueColor RGB Color.

func RGB ¶

func RGB(r, g, b uint8) Color

RGB creates a 24-bit TrueColor RGB Color.

type ColorType ¶

type ColorType = cell.ColorType

Re-exported Core Types

type Constraint ¶

type Constraint = layout.Constraint

Re-exported Core Types

func Fill ¶

func Fill() Constraint

Fill creates a constraint that expands to take all remaining available space.

func Fixed ¶

func Fixed(n uint16) Constraint

Fixed creates a fixed-size layout constraint.

func Max ¶

func Max(m uint16) Constraint

Max creates a constraint that specifies a maximum size.

func Min ¶

func Min(m uint16) Constraint

Min creates a constraint that specifies a minimum size.

func Percentage ¶

func Percentage(p uint16) Constraint

Percentage creates a percentage-based layout constraint (0-100).

func Ratio ¶

func Ratio(val uint16) Constraint

Ratio creates a ratio-based layout constraint.

type Context ¶

type Context = cell.Context

Re-exported Core Types

type Dialog ¶

type Dialog = widgets.Dialog

Re-exported Core Types

type Direction ¶

type Direction = layout.Direction

Re-exported Core Types

type Event ¶

type Event = backend.Event

Re-exported Core Types

type EventType ¶

type EventType = backend.EventType

Re-exported Core Types

type FlexLayout ¶

type FlexLayout = layout.FlexLayout

Re-exported Core Types

type Frame ¶

type Frame = terminal.Frame

Re-exported Core Types

type Insets ¶

type Insets = widgets.Insets

Re-exported Core Types

type KeyEvent ¶

type KeyEvent = backend.KeyEvent

Re-exported Core Types

type KeyType ¶

type KeyType = backend.KeyType

Re-exported Core Types

type Layout ¶

type Layout = layout.FlexLayout

Re-exported Core Types

type Line ¶

type Line = widgets.Line

Re-exported Core Types

func NewLine ¶

func NewLine(spans ...Span) Line

NewLine creates a rich-text Line from styled Spans.

type List ¶

type List = widgets.List

Re-exported Core Types

func NewList ¶

func NewList(items ...string) *List

NewList creates a new List widget with the provided items.

type ListState ¶

type ListState = widgets.ListState

Re-exported Core Types

func NewListState ¶

func NewListState() *ListState

NewListState creates a new ListState for tracking list item selection and scroll offsets.

type Markdown ¶

type Markdown = widgets.Markdown

Re-exported Core Types

func NewMarkdown ¶

func NewMarkdown(content string) *Markdown

NewMarkdown creates a new Markdown rendering widget.

type Modifier ¶

type Modifier = cell.Modifier

Re-exported Core Types

type MouseButton ¶

type MouseButton = backend.MouseButton

Re-exported Core Types

type MouseEvent ¶

type MouseEvent = backend.MouseEvent

Re-exported Core Types

type Paragraph ¶

type Paragraph = widgets.Paragraph

Re-exported Core Types

func NewParagraph ¶

func NewParagraph(text string) *Paragraph

NewParagraph creates a new Paragraph widget with word-wrapping enabled.

type Point ¶

type Point = cell.Point

Re-exported Core Types

type ProgressBar ¶

type ProgressBar = widgets.ProgressBar

Re-exported Core Types

type RadioButton ¶

type RadioButton = widgets.RadioButton

Re-exported Core Types

type Rect ¶

type Rect = cell.Rect

Re-exported Core Types

func NewRect ¶

func NewRect(x, y, w, h uint16) Rect

NewRect creates a new Rect with specified x, y, width, and height.

func SplitHorizontal ¶

func SplitHorizontal(area Rect, constraints ...Constraint) []Rect

SplitHorizontal splits an area horizontally according to constraints.

func SplitVertical ¶

func SplitVertical(area Rect, constraints ...Constraint) []Rect

SplitVertical splits an area vertically according to constraints.

type Select ¶

type Select = widgets.Select

Re-exported Core Types

type SelectState ¶

type SelectState = widgets.SelectState

Re-exported Core Types

func NewSelectState ¶

func NewSelectState() *SelectState

NewSelectState creates a new SelectState for dropdown selection.

type Slider ¶

type Slider = widgets.Slider

Re-exported Core Types

type SliderState ¶

type SliderState = widgets.SliderState

Re-exported Core Types

func NewSliderState ¶

func NewSliderState(value int) *SliderState

NewSliderState creates a new SliderState with the given initial value.

type Span ¶

type Span = widgets.Span

Re-exported Core Types

func NewSpan ¶

func NewSpan(text string, style Style) Span

NewSpan creates a styled Span for rich-text lines.

type Style ¶

type Style = cell.Style

Re-exported Core Types

func Bg ¶

func Bg(c Color) Style

Bg returns a Style with the given background color.

func Bold ¶

func Bold() Style

Bold returns a bold Style.

func Dim ¶

func Dim() Style

Dim returns a dim/faint Style.

func Fg ¶

func Fg(c Color) Style

Fg returns a Style with the given foreground color.

func Italic ¶

func Italic() Style

Italic returns an italic Style.

func NewStyle ¶

func NewStyle() Style

NewStyle returns an empty default Style.

func Reverse ¶

func Reverse() Style

Reverse returns a reverse (inverted foreground/background) Style.

func Underline ¶

func Underline() Style

Underline returns an underline Style.

type Table ¶

type Table = widgets.Table

Re-exported Core Types

func NewTable ¶

func NewTable() *Table

NewTable creates a new Table widget with grid lines enabled by default.

type TableCell ¶

type TableCell = widgets.TableCell

Re-exported Core Types

type TableConstraint ¶

type TableConstraint = widgets.TableConstraint

Re-exported Core Types

type TableRow ¶

type TableRow = widgets.TableRow

Re-exported Core Types

func NewRow ¶

func NewRow(cells ...string) TableRow

NewRow creates a new TableRow from string cells.

type TableState ¶

type TableState = widgets.TableState

Re-exported Core Types

func NewTableState ¶

func NewTableState() *TableState

NewTableState creates a new TableState for tracking selection, scrolling, and column sizes.

type Terminal ¶

type Terminal = terminal.Terminal

Re-exported Core Types

func New ¶

func New() (*Terminal, error)

New initializes standard OS input/output, switches to raw mode, enables mouse and TrueColor tracking, and returns a fully ready-to-use Terminal. The caller should defer term.Close() to restore the terminal state.

type Text ¶

type Text = widgets.Text

Re-exported Core Types

func NewText ¶

func NewText(lines ...Line) *Text

NewText creates a new rich Text widget with the provided lines.

type TextAlignment ¶

type TextAlignment = widgets.TextAlignment

Re-exported Core Types

type TextArea ¶

type TextArea = widgets.TextArea

Re-exported Core Types

type TextAreaState ¶

type TextAreaState = widgets.TextAreaState

Re-exported Core Types

func NewTextAreaState ¶

func NewTextAreaState() *TextAreaState

NewTextAreaState creates a new TextAreaState for multiline text editing.

type TextInput ¶

type TextInput = widgets.TextInput

Re-exported Core Types

func NewTextInput ¶

func NewTextInput(id string) *TextInput

NewTextInput creates a single-line interactive TextInput widget with the specified ID.

type TextInputState ¶

type TextInputState = widgets.TextInputState

Re-exported Core Types

func NewTextInputState ¶

func NewTextInputState() *TextInputState

NewTextInputState creates a new TextInputState for managing typed text and cursor position.

type Widget ¶

type Widget = widgets.Widget

Re-exported Core Types

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
animation
benchmarks
runners/compare command
runners/dashboard command
runners/limoni command
cmd
limoni command Command limoni, Limoni TUI projeleri için iskelet (scaffold) üretir.	Command limoni, Limoni TUI projeleri için iskelet (scaffold) üretir.
compat
bubbletea
core
accessibility Package accessibility contains semantic UI metadata independent of rendering.	Package accessibility contains semantic UI metadata independent of rendering.
backend
buffer
cell
runtime Package runtime provides an optional Init/Update/View application runtime.	Package runtime provides an optional Init/Update/View application runtime.
terminal
examples
3d_viewer command
animation command
ascii3d command ascii3d demonstrates real-time 3D ASCII & sub-cell rendering in Limoni TUI.	ascii3d demonstrates real-time 3D ASCII & sub-cell rendering in Limoni TUI.
charts command
custom_widget command
dashboard command
demo command Limoni Flagship Interactive Demo Designed with a clean, professional sidebar layout, full mouse click interaction, and studio-quality 3D lemon model rendering.	Limoni Flagship Interactive Demo Designed with a clean, professional sidebar layout, full mouse click interaction, and studio-quality 3D lemon model rendering.
forms command forms demonstrates the Select and Slider widgets.	forms demonstrates the Select and Slider widgets.
layer_demo command layer_demo demonstrates Limoni layered rendering capabilities: - Layered Rendering with z-index based compositing - Modal Dialog with Focus Trapping - Popup / Dropdown menus - Click-outside dismissal mechanism	layer_demo demonstrates Limoni layered rendering capabilities: - Layered Rendering with z-index based compositing - Modal Dialog with Focus Trapping - Popup / Dropdown menus - Click-outside dismissal mechanism
paint command
showcase command
simple command
ssh_server command
table_virtual command
toast command
todo command
treeview command
wasm command
graphics
internal
tools/widgetdocs command Command widgetdocs, widgets paketindeki kaynak koddan docs/widget-gallery.md dosyasını üretir.	Command widgetdocs, widgets paketindeki kaynak koddan docs/widget-gallery.md dosyasını üretir.
layout
testkit Package testkit provides deterministic, terminal-independent helpers for testing Limoni widgets and frames.	Package testkit provides deterministic, terminal-independent helpers for testing Limoni widgets and frames.
widgets

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

README ¶

🍋 Limoni

⚡ Overview

💡 Why Limoni?

Key Advantages:

🎬 Showcase & Demos

🎮 3D Mesh & Vector Graphics Engine

📁 Superfile-Grade TreeView & Image Previews

📊 High-Resolution Charts & Data Visualization

✨ Key Features

🚀 Quick Start

Installation

1. Minimal TEA (The Elm Architecture) Example

📚 Documentation

🧩 Rich Widget Ecosystem

🏛️ Architecture

📊 Benchmarks

Verified Benchmark Results (120×40 Viewport, AMD Ryzen / EPYC):

📂 Examples & Showcase Applications

🌟 Awesome Limoni

🤝 Contributing

🛡️ Security Policy

📜 Code of Conduct

📄 License

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func Run ¶

func RuneWidth ¶

func Start ¶

func StringWidth ¶

Types ¶

type Alignment ¶

type Backend ¶

type Block ¶

func NewBlock ¶

type BorderSymbols ¶

type Buffer ¶

type Cell ¶

type Checkbox ¶

type Color ¶

func ANSI ¶

func Hex ¶

func RGB ¶

type ColorType ¶

type Constraint ¶

func Fill ¶

func Fixed ¶

func Max ¶

func Min ¶

func Percentage ¶

func Ratio ¶

type Context ¶

type Dialog ¶

type Direction ¶

type Event ¶

type EventType ¶

type FlexLayout ¶

type Frame ¶

type Insets ¶

type KeyEvent ¶

type KeyType ¶

type Layout ¶

type Line ¶

func NewLine ¶

type List ¶

func NewList ¶

type ListState ¶

func NewListState ¶

type Markdown ¶

func NewMarkdown ¶

type Modifier ¶

type MouseButton ¶

type MouseEvent ¶

type Paragraph ¶

func NewParagraph ¶

type Point ¶

type ProgressBar ¶