ktsu.TUI.Core 1.0.3
ktsu.TUI
A modern, extensible Text User Interface (TUI) library for .NET applications built on top of Spectre.Console. This library provides a clean, object-oriented approach to building interactive terminal applications with rich visual features.
Overview
ktsu.TUI is designed with SOLID principles and provides a modular architecture for creating terminal-based user interfaces. It features:
- Modular Architecture: Clean separation of concerns with contracts, models, services, and UI elements
- Event-Driven Rendering: Efficient rendering system that only updates when needed
- Extensible Design: Easy to extend with custom UI elements and layouts
- Provider Abstraction: Pluggable console providers (currently supports Spectre.Console)
- Dependency Injection Ready: Built with DI in mind for easy integration
Features
✓ Rich Text Styling: Bold, italic, underline, colors, and background colors
✓ Border Elements: Multiple border styles (single, double, rounded, thick, ASCII, none)
✓ Layout System: Stack panels with horizontal/vertical orientation and spacing
✓ Input Handling: Keyboard input processing with ESC to exit
✓ Alignment Support: Horizontal and vertical text alignment
✓ Padding & Positioning: Flexible positioning and padding system
✓ Responsive Design: Automatic sizing based on content and container dimensions
Architecture
Contracts → Models → Services
↓ ↓ ↓
Elements → Layouts → Primitives
↓
Provider Abstraction
- Contracts: Interfaces defining the core abstractions
- Models: Data structures for styling, positioning, and input
- Services: Core application logic and console providers
- Elements: UI components (primitives like borders/text, layouts like stack panels)
- Extensions: Helper methods and utilities
Installation
Add the NuGet package:
dotnet add package ktsu.TUI
Quick Start
using ktsu.TUI.Core.Services;
using ktsu.TUI.Core.Elements.Primitives;
using ktsu.TUI.Core.Elements.Layouts;
using ktsu.TUI.Core.Models;
// Create console provider
var consoleProvider = new SpectreConsoleProvider();
// Create a simple UI
var ui = new BorderElement
{
Title = "My TUI App",
BorderStyle = BorderStyle.Double,
Child = new TextElement
{
Text = "Hello, TUI World!",
Style = new TextStyle { IsBold = true, Foreground = "green" }
}
};
// Create and run application
var app = UIApplication.CreateBuilder(consoleProvider)
.UseRootElement(ui)
.Build();
await app.RunAsync();
Demo Applications
The library includes several demonstration applications:
- Sample App (default): Advanced demo showcasing architecture and features
- Interactive Demo: Interactive controls and real-time updates (
--interactive) - Showcase Demo: Visual demonstration of all styling features (
--showcase)
Run demos:
dotnet run --project TUI.App # Sample app
dotnet run --project TUI.App -- --interactive # Interactive demo
dotnet run --project TUI.App -- --showcase # Showcase demo
Key Components
UI Elements
TextElement: Styled text displayBorderElement: Bordered containers with titlesStackPanel: Horizontal/vertical layout container
Styling
TextStyle: Font styling (bold, italic, underline, colors)BorderStyle: Border appearance (single, double, rounded, etc.)Padding: Space around contentPosition: Element positioning
Input System
- Keyboard input handling
- ESC key to exit applications
- Extensible input event system
Contributing
This project follows clean architecture principles and emphasizes:
- SOLID design principles
- DRY (Don't Repeat Yourself) implementation
- Comprehensive testing
- Clear separation of concerns
License
MIT License. Copyright (c) ktsu.dev
No packages depend on ktsu.TUI.Core.
## v1.0.3 (patch)
Changes since v1.0.2:
- Add step to ensure NuGet cache directory exists in workflow ([@matt-edmondson](https://github.com/matt-edmondson))
## v1.0.2 (patch)
Changes since v1.0.1:
- Update BorderStyle enum and related references across the codebase ([@matt-edmondson](https://github.com/matt-edmondson))
- Enhance documentation and tags for TUI library ([@matt-edmondson](https://github.com/matt-edmondson))
- migrate to dotnet 10 ([@matt-edmondson](https://github.com/matt-edmondson))
- Implement Directory.Build.props and update test class access modifiers ([@matt-edmondson](https://github.com/matt-edmondson))
- Update configuration files and scripts for improved build and test processes ([@matt-edmondson](https://github.com/matt-edmondson))
- Update .editorconfig settings, .gitignore entries, and various project files ([@matt-edmondson](https://github.com/matt-edmondson))
- Refactor TUI application classes to use target-typed new expressions and change access modifiers ([@matt-edmondson](https://github.com/matt-edmondson))
- Enhance TUI library with new features and documentation ([@matt-edmondson](https://github.com/matt-edmondson))
## v1.0.2-pre.3 (prerelease)
Changes since v1.0.2-pre.2:
- Bump the ktsu group with 4 updates ([@dependabot[bot]](https://github.com/dependabot[bot]))
## v1.0.2-pre.2 (prerelease)
Changes since v1.0.2-pre.1:
- Bump Microsoft.NET.Test.Sdk from 17.14.0 to 17.14.1 ([@dependabot[bot]](https://github.com/dependabot[bot]))
## v1.0.2-pre.1 (prerelease)
Incremental prerelease update.
## v1.0.1 (patch)
Changes since v1.0.0:
- Implement Directory.Build.props to manage warnings and errors, enhance BorderElement and TextStyle with convenience properties, and introduce InputModifiers for backward compatibility. Update tests to reflect changes in input handling and property access. ([@matt-edmondson](https://github.com/matt-edmondson))
## v1.0.1-pre.1 (prerelease)
Incremental prerelease update.
## v1.0.0 (major)
- Add initial implementation of TUI library with core components, UI elements, and demos. Includes cursor ignore files and project configuration for package management. ([@matt-edmondson](https://github.com/matt-edmondson))
- Initial commit for TUI ([@matt-edmondson](https://github.com/matt-edmondson))
.NET 8.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.2)
- Spectre.Console (>= 0.54.0)
- Polyfill (>= 9.7.6)
- Microsoft.SourceLink.GitHub (>= 1.0.0)
- Microsoft.SourceLink.AzureRepos.Git (>= 1.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.2)
.NET 10.0
- Spectre.Console (>= 0.54.0)
- Polyfill (>= 9.7.6)
- Microsoft.SourceLink.GitHub (>= 1.0.0)
- Microsoft.SourceLink.AzureRepos.Git (>= 1.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.2)
.NET 9.0
- Spectre.Console (>= 0.54.0)
- Microsoft.SourceLink.GitHub (>= 1.0.0)
- Polyfill (>= 9.7.6)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.2)
- Microsoft.SourceLink.AzureRepos.Git (>= 1.0.0)