f3fc20306e
* Initial plan * Initial exploration - understanding TextField Caption and Title Co-authored-by: tig <585482+tig@users.noreply.github.com> * Remove TextField.Caption and use Title instead with hotkey support Co-authored-by: tig <585482+tig@users.noreply.github.com> * Add defensive check to ensure TitleTextFormatter.Text is set Co-authored-by: tig <585482+tig@users.noreply.github.com> * Final changes - all tests passing Co-authored-by: tig <585482+tig@users.noreply.github.com> * Fixed bugs. * Add comprehensive tests for caption rendering with attributes validation Co-authored-by: tig <585482+tig@users.noreply.github.com> * Fix: Disable TextField hotkey functionality to prevent input interception TextField's Title is used as a caption/placeholder, not for hotkey navigation. Hotkey visual formatting (underline) is still rendered in the caption, but hotkey functionality is disabled to prevent keys like 'E' and 'F' from being intercepted when typing in the field. Updated test to expect "_Find" instead of "Find" to match resource change. Co-authored-by: tig <585482+tig@users.noreply.github.com> * Fix: Support Alt+key hotkey navigation while allowing normal typing Override AddKeyBindingsForHotKey to only bind Alt+key combinations (e.g., Alt+F for "_Find"), not the bare keys. This allows: - Alt+F to navigate to the TextField with Title="_Find" - Normal typing of 'F', 'E', etc. without interception Previously, both bare key and Alt+key were bound, causing typing issues. Now TextField properly supports hotkey navigation without interfering with text input. Co-authored-by: tig <585482+tig@users.noreply.github.com> * Changes before error encountered Co-authored-by: tig <585482+tig@users.noreply.github.com> * Refactor hotkey handling to support command context Refactored `RaiseHandlingHotKey` to accept an `ICommandContext? ctx` parameter, enabling context-aware hotkey handling. Updated `Command.HotKey` definitions across multiple classes (`View`, `CheckBox`, `Label`, `MenuBarv2`, `RadioGroup`, `TextField`) to utilize the new context parameter. Enhanced XML documentation for `RaiseHandlingHotKey` to clarify its usage and return values. Added a context-aware hotkey handler to `TextField` with additional logic for focus handling. Refactored attribute initialization and improved code readability in `TextField` by aligning parameters and removing unused `HotKeySpecifier` initialization. These changes improve flexibility, maintainability, and consistency across the codebase. * Remove TextField.Caption property; use Title with hotkey navigation support Co-authored-by: tig <585482+tig@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: tig <585482+tig@users.noreply.github.com> Co-authored-by: Tig <tig@users.noreply.github.com>
Terminal.Gui v2
The premier toolkit for building rich console apps for Windows, the Mac, and Linux/Unix.
- The current, stable, release of Terminal.Gui v1 is .
⚠️ Note:
v1is in maintenance mode and we will only accept PRs for issues impacting existing functionality.
- The current
Alpharelease of Terminal.Gui v2 is
⚠️ Note:
Developers starting new TUI projects are encouraged to targetv2 Alpha. The API is significantly changed, and significantly improved. There will be breaking changes in the API before Beta, but the core API is stable.
Quick Start
Paste these commands into your favorite terminal on Windows, Mac, or Linux. This will install the Terminal.Gui.Templates, create a new "Hello World" TUI app, and run it.
(Press CTRL-Q to exit the app)
dotnet new --install Terminal.Gui.templates
dotnet new tui -n myproj
cd myproj
dotnet run
To run the UICatalog demo app that shows all the controls and features of the toolkit, use the following command:
dotnet run --project Examples/UICatalog/UICatalog.csproj
There is also a visual designer (uses Terminal.Gui itself).
Documentation
The full developer documentation for Terminal.Gui is available at gui-cs.github.io/Terminal.Gui.
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
API Reference
For detailed API documentation, see the API Reference.
Installing
Use NuGet to install the Terminal.Gui NuGet package:
v2 Alpha
(Infrequently updated, but stable enough for production use)
dotnet add package Terminal.Gui --version "2.0.0-alpha.*"
v2 Develop
(Frequently updated, but may have breaking changes)
dotnet add package Terminal.Gui --version "2.0.0-develop.*"
Legacy v1
dotnet add package Terminal.Gui --version "1.*
Or, you can use the Terminal.Gui.Templates.
Contributing
See CONTRIBUTING.md for complete contribution guidelines.
Debates on architecture and design can be found in Issues tagged with design.
History
See gui-cs for how this project came to be.