Tig 39d4c7dd3d Fixes #3691 - Adds ViewArrangement.Popover (#3852)
* Added Applicaton.Popover.
Refactored FindDeepestView

* Popover prototype

* Testing highlight

* Fixed click outside issue

* Fixed DialogTests

* Fixed click outside issue (agbain)

* Enabled mouse wheel in Bar

* Enabled mouse wheel in Bar

* Progress. Broke arrangement

* Added popover tests.
Fixed a bunch more CM issues related ot unreliable unit tests.
Updated config.json to include Glyphs.

* Can't set ForceDriver to empty in Resources/config.json.

* added BUGBUG

* Made Position/ScreenPosition clear

* Added View.IsInHierarchy tests

* Added Contextmenuv2 scenario.

* Implemented CM2 in TextView

* Removed unneeded CM stuff from testhelpers

* Shortcut API docs

* Fixed keybinding unit tests

* Fixed mouse handling

* Fighting with CM related unit test failures

* Unit tests pass. I think.

* Shortcut code cleanup

* TextView uses new CM2

* Starting on OnSelect etc...

* Starting on OnSelect etc...

* Fixed ContextMenuv2

* ContextMenu is working again.

* Ugh. ANd fixed button api docs

* Fixed DrawHorizontalShadowTransparent (vertical was already fixed).

* Made Scenarios compatible with #nullable enable

* Undid some keybinding stuff

* Fixed stuff

* Sped up unit tests

* Sped up unit tests 2

* Sped up unit tests 3

* Messing with menus

* merged latest v2_develop

* Added more Popover unit tests

* Added more Popover unit tests2

* Fixed positioning bug

* Fixed mouse bug

* Fixed Bar draw issue

* WIP

* merge v2_develop

* CM2 sorta works

* Enabled Bar subclasses to have IDesignable

* Added ViewportSettings.Transparent

* Region -> nullable enable

* Added ViewportSettigs Editor

* merged v2_develop part 2

* merged v2_develop part 3

* WIP: GetViewsUnderMouse

* WIP: More GetViewsUnderMouse work

* Bars works again

* Added unit tests

* CM now works

* MenuItemv2 POC

* SubMenu POC

* CommandNotBound

* More POC

* Optimize Margin to not defer draw if there's no shadow

* Logger cleanup

* Reverted Generic

* Cascading mostly working

* fixed layout bug

* API docs

* API docs

* Fixed cascade

* Events basically work

* code cleanup

* Fixed IsDefault bug;

* Enabled hotkey support

* Made context-menu-like

* Improved usability

* Refactored ApplicationPopover again

* Cleanup

* Menuv2 POC basically complete

* Code Cleanup

* Made menu API simpler

* Fixed Strings bugs

* Got old ContextMenu scenario mostly working

* ContextMenu scenario now works

* ContextMenu fixes

* ContextMenu fixes

* Tons of menu cleanup

* ContextMenu works in TextView

* Fixed unit tes

* Added unit tests

* Fixed tests

* code cleanup

* More code cleanup

* Deep dive

* scenario

* typos

* Demo colorpicker in a Menu

* Added Region tests proving Region is broken in some Union cases

* fixed v2win/net
2025-03-29 11:30:52 -06:00
2025-03-21 09:24:31 +01:00
2025-03-06 12:48:44 -07:00
2024-06-25 05:53:19 -07:00
2024-08-27 07:10:42 -07:00
2025-03-06 12:48:44 -07:00
2024-11-25 15:58:51 +01:00
2025-03-21 08:18:46 +01:00

Terminal.Gui .NET Core Version Code Coverage Downloads License Bugs

  • The current, stable, release of Terminal.Gui v1 is Version.
  • The current prealpha release of Terminal.Gui v2 can be found on Nuget.
  • Developers starting new TUI projects are encouraged to target v2. The API is significantly changed, and significantly improved. There will be breaking changes in the API before Beta, but the core API is stable.
  • v1 is in maintenance mode and we will only accept PRs for issues impacting existing functionality.

Terminal.Gui: A toolkit for building rich console apps for Windows, the Mac, and Linux/Unix.

Sample app

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

There is also a visual designer (uses Terminal.Gui itself).

Documentation

The above documentation matches the most recent Nuget release from the v2_develop branch. Get the v1 documentation here.

See the Terminal.Gui/README for an overview of how the library is structured.

Showcase & Examples

Terminal.Gui can be used with any .Net language to create feature rich and robust applications.
Showcase is a place where you can find all kind of projects from simple examples to advanced real world apps that fully utilize capabilities of the toolkit.
The team is looking forward to seeing new amazing projects made by the community to be added there!

Sample Usage in C#

The following example shows a basic Terminal.Gui application in C#:
Example (source)

When run the application looks as follows:

Simple Usage app

Sample usage in F#

F# examples are located here

Installing

Use NuGet to install the Terminal.Gui NuGet package: https://www.nuget.org/packages/Terminal.Gui

Installation in .NET Core Projects

To install Terminal.Gui into a .NET Core project, use the dotnet CLI tool with this command.

dotnet add package Terminal.Gui

Or, you can use the Terminal.Gui.Templates.

Contributing

See CONTRIBUTING.md.

Debates on architecture and design can be found in Issues tagged with design.

History

See gui-cs for how this project came to be.

Languages
C# 99.4%
PowerShell 0.6%