Terminal.Gui - Terminal GUI toolkit for .NET
A simple toolkit for buiding console GUI apps for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix.
IMPORTANT RELEASE INFO
We are actively converging on a major update to Terminal.Gui.
The most recent released Nuget package is version 0.81
which is way behind master
. This README and the API
Documentation refers to the latest build from master
.
If you want the latest and greatest functionality, clone and build
locally. Otherwise 0.81
is quite stable, but the
documentation may not match.
Controls & Features
The Terminal.Gui toolkit contains various controls for building text user interfaces:
- Button
- CheckBox
- ComboBox
- Dialog
- FrameView
- Hex viewer/editor
- Label
- ListView
- Menu
- MessageBox
- ProgressBar
- Radio buttons
- Time & Date Fields
- TextField
- Text Editor
- ScrollView
- ScrollBarView
- StatusBar
- Window
In addition, a complete Xterm/Vt100 terminal emulator that you
can embed is now part of XtermSharp - you just need to pull TerminalView.cs
into your
project.
Features
- Cross Platform - Terminal drivers for Curses, Windows Console, and the .NET Console mean Terminal.Gui works well on both color and monochrome terminals and has mouse support on terminal emulators that support it.
- Keyboard and Mouse Input - Both keyboard and mouse input are supported, including limited support for drag & drop.
- Flexible Layout - Terminal.Gui supports both Absolute layout and an innovative UI layout system referred to as Computed Layout. Computed Layout makes it easy to layout controls relative to each other and enables dynamic console GUIs.
- 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.
Keyboard Input Handling
The input handling of Terminal.Gui is similar in some ways to Emacs and the Midnight Commander, so you can expect some of the special key combinations to be active.
The key ESC
can act as an Alt modifier (or Meta in
Emacs parlance), to allow input on terminals that do not have an
alt key. So to produce the sequence Alt-F
, you can
press either Alt-F
, or ESC
followed by
the key F
.
To enter the key ESC
, you can either press
ESC
and wait 100 milliseconds, or you can press
ESC
twice.
ESC-0
, and ESC-1
through
ESC-9
have a special meaning, they map to
F10
, and F1
to F9
respectively.
Terminal.Gui respects common Mac and Windows
keyboard idoms as well. For example, clipboard operations use the
familiar Control/Command-C, X, V
model.
CTRL-Q
is used for exiting views (and apps).
Driver model
Currently Terminal.Gui has support for ncurses, System.Console
, and a full
Win32 Console front-end.
ncurses
is used on Mac/Linux/Unix with color
support based on what your library is compiled with; the Windows
driver supports full color and mouse, and an easy-to-debug
System.Console
can be used on Windows and Unix, but
lacks mouse support.
You can force the use of System.Console
on Unix as
well; see Core.cs
.
Design
See the Terminal.Gui/
README for an
overview of how the library is structured. The Conceptual Documentation provides insight into
core concepts.
Debates on architecture and design can be found in Issues tagged with design.
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
in theUICatalog
directory to run the UI Catalog. - Example (aka
demo.cs
) - Rundotnet run
in theExample
directory to run the simple demo. - Standalone Example - A trivial .NET core
sample application can be found in the
StandaloneExample
directory. Rundotnet run
in directory to test.
Documentation
Sample Usage
using Terminal.Gui;
class Demo {
static void Main ()
{
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", NewFile),
new MenuItem ("_Close", "", () => Close ()),
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);
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
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 [] { "_Personal", "_Company" }),
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 ();
}
}
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> ();
}
}
The example above shows how to add views using both styles of layout supported by Terminal.Gui: Absolute layout and Computed layout.
Installing
We are actively converging on a major update to
Terminal.Gui. The most recent released Nuget package is version
0.81
which is way behind master
. This
README and the API Documentation refers to the latest build from
master
. If you want the latest and greatest
functionality, clone and build locally. Otherwise 0.81
is quite stable, but the documentation may not match.
Use NuGet to install the Terminal.Gui
NuGet
package: https://www.nuget.org/packages/Terminal.Gui
Running and Building
- Windows, Mac, and Linux - Build and run using the .NET SDK
command line tools (
dotnet build
in the root directory) - Windows - Open
Terminal.Gui.sln
with Visual Studio 2019.
Contributing
See CONTRIBUTING.md.
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
Release history can be found in the Terminal.Gui.csproj file.
In 2019 and 2020, Charlie Kindel (https://github.com/tig) and @BDisp (https://github.com/BDisp) vastly extended, improved, polished and fixed gui.cs to what it is today.