index.md 3.1 KB
Terminal.Gui Documentation
[!IMPORTANT] Terminal.Gui v2 "Alpha" has been released.
Welcome to the Terminal.Gui documentation! This comprehensive guide covers everything you need to know about building modern terminal user interfaces with Terminal.Gui.
[!NOTE] This is the v2 API documentation. For v1 go here: https://gui-cs.github.io/Terminal.GuiV1Docs/
Getting Started
- Getting Started - Quick start guide to create your first Terminal.Gui application
- Migrating from v1 to v2 - Complete guide for upgrading existing applications
- What's New in v2 - Overview of new features and improvements
- Showcase - Showcase of TUI apps built with Terminal.Gui
Deep Dives
- ANSI Response Parser - Terminal sequence parsing and state management
- Application - Application lifecycle, initialization, and main loop
- Arrangement - View arrangement and positioning strategies
- Cancellable Work Pattern - Core design pattern for extensible workflows
- Character Map Scenario - Complex drawing, scrolling, and Unicode rendering example
- Command System - Command execution, key bindings, and the Selecting/Accepting concepts
- Configuration Management - Persistent settings, themes, and configuration scopes
- Cross-Platform Driver Model - Platform abstraction and console driver architecture
- Cursor System - Modern cursor management and positioning (proposed design)
- Dim.Auto - Automatic view sizing based on content
- Drawing - Drawing primitives, rendering, and graphics operations
- Events - Event patterns and handling throughout the framework
- Keyboard Input - Key handling, bindings, commands, and shortcuts
- Layout System - View positioning, sizing, and arrangement
- Lexicon & Taxonomy - Terminology and concepts used throughout Terminal.Gui
- Logging & Metrics - Comprehensive logging and performance monitoring
- Multitasking - Application lifecycle and event dispatching
- Mouse Input - Mouse event handling and interaction patterns
- Navigation - Focus management, keyboard navigation, and accessibility
- Popovers - Drawing outside viewport boundaries for menus and popups
- Scheme - Color schemes, styling, and visual theming
- Scrolling - Built-in scrolling, virtual content areas, and scroll bars
- TableView - Table view component, data binding, and column management
- TreeView - Tree view component, hierarchical data, and node management
- View - Base view class, view hierarchy, and core view functionality
API Reference
For detailed API documentation, see the API Reference.