TermuiX 2.0.0

TermuiX

A declarative terminal UI library for .NET. Define your interface in XML, style with TrueColor, handle mouse and keyboard input, and build real applications.

Changelog

v2.0.0

• Cross-platform mouse input (Windows P/Invoke, Unix ANSI SGR)
• Click-to-focus, scroll wheel, hover, drag support
• Right-click events on Button
• StackPanel layout engine with Direction, Justify, Align, Wrap
• Fill sizing for flexible layouts (distributes remaining space)
• StackPanel margin support in layout calculation
• Percentage rounding fix for gap-free cumulative layouts
• Color.Inherit for cascading colors through the widget tree
• TrueColor RGB support (#RRGGBB, #RGB, rgb(R,G,B))
• Min/Max width and height constraints (MinWidth, MaxWidth, MinHeight, MaxHeight)
• TreeView widget with expand/collapse, keyboard navigation, mouse, SelectNode API
• Style element for bulk property application (name and group matching, like CSS)
• Markdown rendering in Text widget (bold, italic, code, strikethrough, fenced code blocks)
• ANSI SGR text styles (rendered via escape sequences instead of Unicode substitution)
• ScrollX/ScrollY per-axis scroll control (Scrollable remains as convenience for both)
• Insert API on Container (Insert at specific index)
• Ctrl+Wheel horizontal scroll, auto-detect scroll direction for horizontal-only containers
• Zero-width character support in GetRuneDisplayWidth (combining marks, variation selectors)
• Fixed UTF-8 multi-byte decoding in Unix mouse input
• Fixed StackPanel cross-axis sizing, auto-size with margins, shrink-wrap with MaxWidth
• AiChat sample: AI chat interface with markdown rendering and streaming
• FileManager2 sample: modern TUI file manager with TreeView, tabs, context menu, file operations

v1.1.0

• Custom widget and component registration for XML parser
• Disabled state for all interactive widgets with DisabledBackgroundColor/DisabledForegroundColor
• .NET 10.0 multi-targeting and Native AOT support
• Emoji and Unicode support with proper display width calculation (East Asian, zero-width characters)
• Widget cloning (deep and shallow)
• Reusable component model (BuildXml + Initialize pattern)
• FileManager sample with file operations, filter, sort, dropdowns, confirmation dialogs
• Focus improvements and auto-scroll to keep focused widget visible
• Multiline Input navigation fix
• Fixed clipping and relative positioning bugs

v1.0.0

• Initial release with XML-based declarative UI
• Widgets: Container, Button, Text, Input, Checkbox, RadioButton, Slider, ProgressBar, Chart, Table, Line
• XML parser for widget tree construction
• Keyboard navigation (Tab/Shift+Tab)
• Scrollable containers with scroll wheel support
• Text formatting (Bold, Italic, Underline, Strikethrough)
• Horizontal scrolling and Slider widget
• Border styles (Single, Double, RoundedCorners)
• Percentage and character unit sizing
• Padding on all widgets
• GetWidget/GetWidgetsByGroup for widget lookup by name or group

Installation

dotnet add package TermuiX

Quick Start

using TermuiXLib = TermuiX.TermuiX;
using TermuiX.Widgets;

var termui = TermuiXLib.Init();
try
{
    termui.LoadXml(@"
    <StackPanel Direction='Vertical' Width='100%' Height='100%'
        BackgroundColor='#1e1e2e' PaddingLeft='2ch' PaddingTop='1ch'>
        <Text ForegroundColor='#cdd6f4' Style='Bold'>Hello, TermuiX!</Text>
        <Button Name='btn' Width='15ch' MarginTop='1ch'
            BackgroundColor='#313244' FocusBackgroundColor='#45475a'
            TextColor='#cdd6f4' FocusTextColor='#ffffff'
            BorderColor='#45475a' FocusBorderColor='#89b4fa'
            BorderStyle='Single' RoundedCorners='true'>Click Me</Button>
        <Text Name='output' ForegroundColor='#a6adc8' MarginTop='1ch' />
    </StackPanel>");

    var btn = termui.GetWidget<Button>("btn");
    var output = termui.GetWidget<Text>("output");
    btn!.Click += (_, _) => output!.Content = "Button clicked!";

    while (true)
    {
        termui.Render();
        await Task.Delay(16);
    }
}
finally
{
    TermuiXLib.DeInit();
}

Documentation

Full documentation is available in the docs/ directory:

• Introduction and API Reference
• Layout System - Container, StackPanel, sizing (ch, %, fill, auto), margins, padding
• Widget Reference - Every widget with all properties, events, and behaviors
• Styling - Colors, borders, focus states, text styles, Style element
• Events and Input - Mouse, keyboard, focus system, shortcuts
• XML Reference - Parser syntax, dynamic Add/Remove, custom widgets
• Best Practices - Known behaviors, layout quirks, patterns
• Examples - Complete working examples

Widgets

Requirements

• .NET 9.0 or .NET 10.0
• Terminal with Unicode and ANSI color support
• Full Native AOT compatibility

Samples

• TermuiX.Demo16 - Modern dashboard with all widgets (the README screenshot)
• TermuiX.FileManager2 - Modern TUI file manager with TreeView, tabs, context menu, file operations
• TermuiX.AiChat - AI chat interface with markdown rendering

Run a sample:

dotnet run --project samples/TermuiX.Demo16

License

MIT License - see LICENSE file for details.