Terminal.Gui 1.8.2

.NET 6.0 .NET Standard 2.0 .NET Framework 4.7.2
dotnet add package Terminal.Gui --version 1.8.2
NuGet\Install-Package Terminal.Gui -Version 1.8.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Terminal.Gui" Version="1.8.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Terminal.Gui --version 1.8.2
#r "nuget: Terminal.Gui, 1.8.2"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Terminal.Gui as a Cake Addin
#addin nuget:?package=Terminal.Gui&version=1.8.2

// Install Terminal.Gui as a Cake Tool
#tool nuget:?package=Terminal.Gui&version=1.8.2

.NET Core Code scanning - action Version Code Coverage Downloads License Bugs

Terminal.Gui - Cross Platform Terminal UI toolkit for .NET

A toolkit for building rich console apps for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix.

Sample app

Documentation

The Documentation matches the most recent Nuget release from the main branch (Version)

Features

  • Cross Platform - Windows, Mac, and Linux. Terminal drivers for Curses, Windows Console, and the .NET Console mean apps will work well on both color and monochrome terminals.
  • Keyboard and Mouse Input - Both keyboard and mouse input are supported, including support for drag & drop.
  • Flexible Layout - Supports both Absolute layout and an innovative Computed Layout system. Computed Layout makes it easy to layout controls relative to each other and enables dynamic terminal UIs.
  • Clipboard support - Cut, Copy, and Paste of text provided through the Clipboard class.
  • Arbitrary Views - All visible UI elements are subclasses of the View class, and these in turn can contain an arbitrary number of sub-views.
  • Advanced App Features - The Mainloop supports processing events, idle handlers, timers, and monitoring file descriptors. Most classes are safe for threading.
  • Reactive Extensions - Use reactive extensions and benefit from increased code readability, and the ability to apply the MVVM pattern and ReactiveUI data bindings. See the source code of a sample app in order to learn how to achieve this.

Showcase & Examples

  • UI Catalog - The UI Catalog project provides an easy to use and extend sample illustrating the capabilities of Terminal.Gui. Run dotnet run --project UICatalog to run the UI Catalog.
  • Reactive Example - A sample app that shows how to use System.Reactive and ReactiveUI with Terminal.Gui. The app uses the MVVM architecture that may seem familiar to folks coming from WPF, Xamarin Forms, UWP, Avalonia, or Windows Forms. In this app, we implement the data bindings using ReactiveUI WhenAnyValue syntax and Pharmacist — a tool that converts all events in a NuGet package into observable wrappers.
  • Example (aka demo.cs) - Run dotnet run in the Example directory to run the simple demo.
  • Standalone Example - A trivial .NET core sample application can be found in the StandaloneExample directory. Run dotnet run in directory to test.
  • F# Example - An example showing how to build a Terminal.Gui app using F#.
  • PowerShell's Out-ConsoleGridView - OCGV sends the output from a command to an interactive table.
  • PoshRedisViewer - A compact Redis viewer module for PowerShell written in F# and Gui.cs
  • TerminalGuiDesigner - Cross platform view designer for building Terminal.Gui applications.

See the Terminal.Gui/ README for an overview of how the library is structured. The Conceptual Documentation provides insight into core concepts.

Sample Usage

(This code uses C# 9.0 Top-level statements.)

using Terminal.Gui;
using NStack;

Application.Init();
var top = Application.Top;

// Creates the top-level window to show
var win = new Window("MyApp")
{
	X = 0,
	Y = 1, // Leave one row for the toplevel menu

	// By using Dim.Fill(), it will automatically resize without manual intervention
	Width = Dim.Fill(),
	Height = Dim.Fill()
};

top.Add(win);

// Creates a menubar, the item "New" has a help menu.
var menu = new MenuBar(new MenuBarItem[] {
			new MenuBarItem ("_File", new MenuItem [] {
				new MenuItem ("_New", "Creates new file", null),
				new MenuItem ("_Close", "",null),
				new MenuItem ("_Quit", "", () => { if (Quit ()) top.Running = false; })
			}),
			new MenuBarItem ("_Edit", new MenuItem [] {
				new MenuItem ("_Copy", "", null),
				new MenuItem ("C_ut", "", null),
				new MenuItem ("_Paste", "", null)
			})
		});
top.Add(menu);

static bool Quit()
{
	var n = MessageBox.Query(50, 7, "Quit Demo", "Are you sure you want to quit this demo?", "Yes", "No");
	return n == 0;
}

var login = new Label("Login: ") { X = 3, Y = 2 };
var password = new Label("Password: ")
{
	X = Pos.Left(login),
	Y = Pos.Top(login) + 1
};
var loginText = new TextField("")
{
	X = Pos.Right(password),
	Y = Pos.Top(login),
	Width = 40
};
var passText = new TextField("")
{
	Secret = true,
	X = Pos.Left(loginText),
	Y = Pos.Top(password),
	Width = Dim.Width(loginText)
};

// Add some controls, 
win.Add(
	// The ones with my favorite layout system, Computed
	login, password, loginText, passText,

	// The ones laid out like an australopithecus, with Absolute positions:
	new CheckBox(3, 6, "Remember me"),
	new RadioGroup(3, 8, new ustring[] { "_Personal", "_Company" }, 0),
	new Button(3, 14, "Ok"),
	new Button(10, 14, "Cancel"),
	new Label(3, 18, "Press F9 or ESC plus 9 to activate the menubar")
);

Application.Run();
Application.Shutdown();

The example above shows adding views using both styles of layout supported by Terminal.Gui: Absolute layout and Computed layout.

Alternatively, you can encapsulate the app behavior in a new Window-derived class, say App.cs containing the code above, and simplify your Main method to:

using Terminal.Gui;

class Demo {
	static void Main ()
	{
		Application.Run<App> ();
		Application.Shutdown ();
	}
}

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 following command.

dotnet add package Terminal.Gui

See CONTRIBUTING.md for instructions for downloading and forking the source.

Running and Building

  • Windows, Mac, and Linux - Build and run using the .NET SDK command line tools (dotnet build in the root directory). Run UICatalog with dotnet run --project UICatalog.
  • Windows - Open Terminal.Gui.sln with Visual Studio 2019.

Contributing

See CONTRIBUTING.md.

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

History

This is an updated version of gui.cs that Miguel wrote for mono-curses in 2007.

The original gui.cs was a UI toolkit in a single file and tied to curses. This version tries to be console-agnostic and instead of having a container/widget model, only uses Views (which can contain subviews) and changes the rendering model to rely on damage regions instead of burdening each view with the details.

A presentation of this was part of the Retro.NET talk at .NET Conf 2018 Slides

The most recent release notes can be found in the Terminal.Gui.csproj file.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (18)

Showing the top 5 NuGet packages that depend on Terminal.Gui:

Package Downloads
Carbon.Kit

Provides interfaces, abstractions and common functions which is the essence of Carbon Kit.

HIC.RDMP.Dicom

Rdmp library containing Dicom attachers, Dicom server cache sources etc.

M5x.TermUi

Package Description

Gtt.FastPass

A library to support running tests against rest APIs

Terminal.Gui.Elmish

An elmish wrapper around Miguel de Icaza's 'Gui.cs' https://github.com/migueldeicaza/gui.cs including F# Feliz-like like view DSL.

GitHub repositories (12)

Showing the top 5 popular GitHub repositories that depend on Terminal.Gui:

Repository Stars
awaescher/RepoZ
👨‍💻 A zero-conf git repository hub for Windows and macOS with Windows Explorer- & CLI-enhancements
NethermindEth/nethermind
Our flagship Ethereum client for Linux, Windows, and macOS—full and actively developed.
PowerShell/GraphicalTools
Modules that mix PowerShell and GUIs/CUIs! - built on Avalonia and gui.cs
paillave/Etl.Net
Mass processing data with a complete ETL for .net developers
bjorkstromm/depends
Tool for generating dependency trees for .NET projects
Version Downloads Last updated
1.8.2 11,365 9/21/2022
1.7.2 11,205 8/4/2022
1.7.1 660 8/1/2022
1.7.0 591 7/28/2022
1.6.4 14,778 5/28/2022
1.6.3 603 5/27/2022
1.6.2 311 5/26/2022
1.6.1 174 5/26/2022
1.6.0 208 5/26/2022
1.5.0 4,737 4/17/2022
1.4.0 21,474 12/18/2021
1.3.1 34,495 10/27/2021
1.2.1 8,626 8/24/2021
1.2.0 448 8/24/2021
1.1.1 87,998 5/17/2021
1.1.0 366 5/16/2021
1.0.0 2,990 4/28/2021
1.0.0-rc.13 133 4/28/2021
1.0.0-rc.12 143 4/27/2021
1.0.0-rc.11 119 4/27/2021
1.0.0-rc.10 130 4/27/2021
1.0.0-rc.9 146 4/27/2021
1.0.0-rc.8 127 4/26/2021
1.0.0-rc.3 112 4/26/2021
1.0.0-rc.2 136 4/26/2021
1.0.0-rc.1 404 4/19/2021
1.0.0-beta.11 1,346 4/1/2021
1.0.0-beta.10 145 4/1/2021
1.0.0-beta.8 249 3/9/2021
0.0.6 171 5/27/2022
0.0.4 169 5/27/2022
0.0.3 165 5/27/2022
0.0.2 167 5/27/2022
0.0.1 198 5/27/2022

Release v1.8.1
     * Fixes #2053. MessageBox.Query not wrapping correctly
     
     Release v1.8.0
     * Fixes #2043. Update to NStack v1.0.3
     * Fixes #2045. TrySetClipboardData test must be enclosed with a lock.
     * Fixes #2025. API Docs are now generated via Github Action - View Source Works
     * Fixes #1991. Broken link in README
     * Fixes #2026. Added ClearOnVisibleFalse to flag if the view must be cleared or not.
     * Fixes #2017 and #2013. MainLoopTests.InvokeLeakTest failures
     * Fixes #2014. Application mouseGrabView is run twice if return true.
     * Fixes #2011. Wizard no longer needs to set specific colors, because #1971 has been fixed.
     * Fixes #2006. ProgressBarStyles isn't disposing the _fractionTimer on quitting if running.
     * Fixes #2004. TextFormatter.Justified not adding the extra spaces.
     * Fixes #2002. Added feature to fill the remaining width with spaces.
     * Fixes #1999. Prevents the mouseGrabView being executed with a null view.
     * Fixes #1994. BREAKING CHANGE. Ensure only a single IdleHandlers list can exist.
     * Fixes #1979. MessageBox.Query not wrapping since 1.7.1
     * Fixes #1989. ListView: Ensures SelectedItem visibility on MoveDown and MoveUp.
     * Fixes #1987. Textview insert text newline fix
     * Fixes #1984. Setting Label.Visible to false does not hide the Label
     * Fixes #820. Added HideDropdownListOnClick property.
     * Fixes #1981. Added SplitNewLine method to the TextFormatter.
     * Fixes #1973. Avoid positioning Submenus off screen.
     * Added abstract MakeColor and CreateColors to create the colors at once.
     * Fixes #1800. TextView now uses the same colors as TextField.
     * Fixes #1969. ESC on CursesDriver take to long to being processed.
     * Fixes #1967. New keys for DeleteAll on TextField and TextView.
     * Fixes #1962 - Change KeyBindings to allow chaining commands
     * Fixes #1961 Null reference in Keybindings Scenario and hotkey collision
     * Fixes #1963. Only remove one character on backspace when wordwrap is on
     * Fixes #1959. GoToEnd should not fail on an empty TreeView
     * Fixes #1953. TextView cursor position is not updating by mouse.
     * Fixes #1951. TextView with selected text doesn't scroll beyond the cursor position.
     * Fixes #1948. Get unwrapped cursor position when word wrap is enabled on TextView.
     * Ensures that the isButtonShift flag is disabled in all situations.
     * Fixes #1943. Mouse ButtonShift is not preserving the text selected.

     Release v1.7.2
     * Fixes #1773. Base color scheme for ListView hard to read
     * Fixes #1934. WindowsDriver crash when the height is less than 1 with the VS Debugger

     Release v1.7.1
     * Fixes #1930. Trailing whitespace makes MessageBox.Query buttons disappear.
     * Fixes #1921. Mouse continuous button pressed is not working on ScrollView.
     * Fixes #1924. Wizard: Selected help text is unreadable

     Release v1.7.0
     * Moved Terminal.Gui (and NStack) to the github.com/gui-cs organization.
     * Adds multi-step Wizard View for setup experiences (#124)
     * The synchronization context method Send is now blocking (#1854).
     * Fixes #1917. Sometimes Clipboard.IsSupported doesn't return the correct
     * Fixes #1893: Fix URLs to match gui-cs Org
     * Fixes #1883. Child TopLevels now get Loaded/Ready events.
     * Fixes #1867, #1866, #1796. TextView enhancements for ReadOnly and WordWrap.
     * Fixes #1861. Border: Title property is preferable to Text.
     * Fixes #1855. Window and Frame content view without the margin frame.
     * Fixes #1848. Mouse clicks in Windows Terminal.
     * Fixes #1846. TabView now clips to the draw bounds.
     * Fix TableView multi selections extending to -1 indexes
     * Fixes #1837. Setting Unix clipboard freezes.
     * Fixes #1839. Process WindowsDriver click event if location is the same after pressed and released.
     * Fixes #1830. If "libcoreclr.so" is not present then "libncursesw.so" will be used.
     * Fixes #1816. MessageBox: Hides underlying dialog when visible
     * Fixes #1815. Now returns false if WSL clipboard isn't supported.
     * Fixes #1825. Parent MenuItem stay focused if child MenuItem is empty.
     * Fixes #1812, #1797, #1791. AutoSize fixes.
     * Fixes #1818. Adds Title change events to Window.
     * Fixes #1810. Dialog: Closing event is not fired when ESC is pressed to close dialog.
     * Fixes #1793. ScrollBarView is hiding if the host fit the available space.
     * Added Pos/Dim Function feature to automate layout.
     * Fixes #1786. Windows Terminal is reporting well on mouse button pressed + mouse movement.
     * Fixes #1777 - Dialog button justification. Adds unit tests.
     * Fixes #1739. Setting menu UseKeysUpDownAsKeysLeftRight as false by default.
     * Fixes #1772. Avoids WindowsDriver flickering when resizing.
     * Fixed TableView always showing selected cell(s) even when not focused
     * Fixes #1769. Supports a minimum view size for non-automatic size views.
     * Exposes APIs to support upcoming Web console feature
     * Fixes some scrolling performance issues
     * Fixes #1763. Allowing read console inputs before idle handlers.
     * TableView unicode scenario usability
     * Added unicode testing code to TableEditor