Terminal.Gui Deep Dives

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
• Lexicon & Taxonomy - Terminology and concepts used throughout Terminal.Gui
• Views - Comprehensive list of built-in views and controls

Deep Dives

• ANSI Handling - Terminal escape sequence parsing, encoding, 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 - Command execution, key bindings, and the Activating/Accepting concepts
• Command Diagrams - Visual diagrams of command flow and processing
• Configuration - Persistent settings, themes, and configuration scopes
• Cursor - Terminal cursor management, positioning, and styles
• Dim.Auto - Automatic view sizing based on content
• Drawing - Drawing primitives, rendering, and graphics operations
• Drivers - Platform abstraction and console driver architecture
• Events - Event patterns and handling throughout the framework
• Input Injection - Testing support for simulating keyboard and mouse input
• Keyboard - Key handling, bindings, commands, and shortcuts
• Layout - View positioning, sizing, and arrangement
• Logging - Comprehensive logging and performance monitoring
• Menus - Menu system architecture including MenuBar, MenuItem, and PopoverMenu
• Mouse - Mouse event handling and interaction patterns
• Multitasking - Background operations and task management
• Navigation - Focus management, keyboard navigation, and accessibility
• Popovers - Drawing outside viewport boundaries for menus and popups
• Prompt - Interactive prompts and user input dialogs
• 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.