huafangyun / terminal.gui

Cross Platform Terminal UI toolkit for .NET

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.

Documentation

• Documentation Home
• Terminal.Gui Overview
• List of Views/Controls
• Conceptual Documentation
• API Documentation

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

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.
• C# Example - Run dotnet run in the Example directory to run the C# Example.
• F# Example - An example showing how to build a Terminal.Gui app using F#.
• 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.
• 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 in C#

// A simple Terminal.Gui example in C# - using C# 9.0 Top-level statements

using Terminal.Gui;
using NStack;

Application.Init ();

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

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

Application.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 a new file", null),
				new MenuItem ("_Close", "",null),
				new MenuItem ("_Quit", "", () => { if (Quit ()) Application.Top.Running = false; })
			}),
			new MenuBarItem ("_Edit", new MenuItem [] {
				new MenuItem ("_Copy", "", null),
				new MenuItem ("C_ut", "", null),
				new MenuItem ("_Paste", "", null)
			})
		});
Application.Top.Add (menu);

static bool Quit ()
{
	var n = MessageBox.Query (50, 7, "Quit Example", "Are you sure you want to quit this example?", "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 the views to the main window, 
win.Add (
	// Using Computed Layout:
	login, password, loginText, passText,

	// Using Absolute Layout:
	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")
);

// Run blocks until the user quits the application
Application.Run ();

// Always bracket Application.Init with .Shutdown.
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.sln with Visual Studio 2022.

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.