Terminal Gui's Built-in Views
Terminal.Gui provides the following set of built-in views and controls for building terminal user interfaces:
Bar
Provides a horizontally or vertically oriented container for Shortcuts to be used as a menu, toolbar, or status bar.
Quit Quit Ctrl+Z Help Help Text F1 ☐ Check
Button
A button View that can be pressed with the mouse or keyboard.
⟦ Button ⟧
CharMap
A scrollable map of the Unicode codepoints.
0 1 2 3 4 5 6 7 8 9 a b c d
U+00000_ ▲
U+00001_ █
U+00002_ ! " # $ % & ' ( ) * + , -░
U+00003_ 0 1 2 3 4 5 6 7 8 9 : ; < =░
U+00004_ @ A B C D E F G H I J K L M░
U+00005_ P Q R S T U V W X Y Z [ \ ]░
U+00006_ ` a b c d e f g h i j k l m░
U+00007_ p q r s t u v w x y z { | }░
U+00008_ ░
U+00009_ ░
U+0000a_ ¡ ¢ £ ¤ ¥ ¦ § ¨ © ª « ¬ ░
U+0000b_ ° ± ² ³ ´ µ ¶ · ¸ ¹ º » ¼ ½░
U+0000c_ À Á Â Ã Ä Å Æ Ç È É Ê Ë Ì Í░
U+0000d_ Ð Ñ Ò Ó Ô Õ Ö × Ø Ù Ú Û Ü Ý░
U+0000e_ à á â ã ä å æ ç è é ê ë ì í░
U+0000f_ ð ñ ò ó ô õ ö ÷ ø ù ú û ü ý░
U+00010_ Ā ā Ă ă Ą ą Ć ć Ĉ ĉ Ċ ċ Č č░
U+00011_ Đ đ Ē ē Ĕ ĕ Ė ė Ę ę Ě ě Ĝ ĝ▼
◄█████████████████████████████████░░░░░░►
CheckBox
Shows a checkbox that can be cycled between two or three states.
☐ Demo Title
ColorPicker
Color Picker supporting RGB, HSL, and HSV color models. Supports choosing colors with sliders and color names from the IColorNameResolver.
H: ▲355
S: ▲ 70
V: ▲ 91
Hex:#E74856 ■
ColorPicker16
A sinple color picker that supports the legacy 16 ANSI colors
┌┄┄┐
└┄┄┘
ComboBox
Provides a drop-down list of items the user can select from.
▼
DateField
Provides date editing functionality with mouse support.
01/01/0001
DatePicker
Lets the user pick a date from a visual calendar.
┌┤Demo Title├────────────────┐
│Date: 05/31/2025 │
│┌───┬───┬───┬───┬───┬───┬──┐│
││Sun│Mon│Tue│Wed│Thu│Fri│Sa││
│├───┼───┼───┼───┼───┼───┼──┤│
││- │- │- │- │1 │2 │3 ││
││4 │5 │6 │7 │8 │9 │10││
││11 │12 │13 │14 │15 │16 │17││
││18 │19 │20 │21 │22 │23 │24││
││25 │26 │27 │28 │29 │30 │31││
││- │- │- │- │- │- │- ││
│└───┴───┴───┴───┴───┴───┴──┘│
│ ◄◄ ►► │
└────────────────────────────┘
Dialog
A Toplevel.Modal Window. Supports a simple API for adding Buttons across the bottom. By default, the Dialog is centered and used the Schemes.Dialog scheme.
┏┥Demo Title┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃Demo Text ┃
┃ ┃
┃ ┃
┃ ┃
┃ ┃
┃ ┃
┃ ┃
┃ ┃
┃ ┃
┃ ┃
┃ ┃
┃ ┃
┃ ┃
┃ ┃
┃ ┃
┃ ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
FileDialog
The base-class for OpenDialog and SaveDialog
┏┥Open┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃C:\Users\Tig\s\gui-cs\Terminal.Gui\doc┃
┃⟦▲⟧ ┃
┃┌────────────────────┬───────────────┐┃
┃│Filename (▲) │Size │┃
┃├────────────────────┼───────────────►┃
┃│.. │ │┃
┃│\_exported_templates│ │┃
┃│\_site │ │┃
┃│\api │ │┃
┃│\docs │ │┃
┃│\images │ │┃
┃│\schemas │ │┃
┃│\scripts │ │┃
┃⟦ ►► ⟧ Enter Search⟦► OK ◄⟧ ⟦ Cancel ⟧┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
FlagSelector
Provides a user interface for displaying and selecting non-mutually-exclusive flags. Flags can be set from a dictionary or directly from an enum type.
☒ No Style
☐ Show None Value Style
☐ Show Value Editor Style
☐ All Styles
0
FlagSelector<T>
Provides a user interface for displaying and selecting non-mutually-exclusive flags. Flags can be set from a dictionary or directly from an enum type.
FrameView
A non-overlapped container for other views with a border and optional title.
╭┤Demo Title├────────────────────────────────────╮
│Demo Text │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
╰────────────────────────────────────────────────╯
GraphView
Displays graphs (bar, scatter, etc.) with flexible labels, scaling, and scrolling
│ .
│ ..
0.60┤ .
┤ ∙
│ .
│ ..
0.20┤.
┬────┬────┬────┬────┬────∙────┬────┬────┬────┬─
-2.50 -1.50 -0.50 .│ 0.50 1.50
↑ . │
Y -0.20┤
.. . │
. ∙ ┤
∙ . │
. .. -0.60┤
.. . │
. ..∙ ┤
∙....∙.. -1.00┤
X →
HexView
Provides a hex editor with the left side showing the hex values of the bytes in a Stream and the right side showing the contents (filtered to printable Unicode glyphs).
00000000 48 65 78 56 ┊ 69 65 77 20 HexView
00000008 64 61 74 61 ┊ 20 77 69 74 data wit
00000010 68 20 77 69 ┊ 64 65 20 63 h wide c
00000018 6f 64 65 70 ┊ 6f 69 6e 74 odepoint
00000020 73 3a 20 f0 ┊ 9d 94 b9 41 s: ����A
00000028 e2 84 9d f0 ┊ 9d 94 bd 21 �������!
00000030 ┊
00000038 ┊
00000040 ┊
00000048 ┊
00000050 ┊
00000058 ┊
00000060 ┊
00000068 ┊
00000070 ┊
00000078 ┊
00000080 ┊
00000088 ┊
00000090 ┊
00000098 ┊
Label
Displays text that describes the View next in the View.SubViews. When the user presses a hotkey that matches the View.HotKey of the Label, the next View in View.SubViews will be activated.
Label
LegendAnnotation
Used by GraphView to render smbol definitions in a graph, e.g. colors and their meanings
┌┤Demo Title├────────────────────────────────────┐
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└────────────────────────────────────────────────┘
Line
Draws a single line using the LineStyle specified by View.BorderStyle.
──────────────────────────────────────────────────
LineView
A straight line control either horizontal or vertical
──────────────────────────────────────────────────
ListView
Provides a scrollable list of data where each item can be activated to perform an action.
List Item 1
List Item two
List Item Quattro
Last List Item
MenuBar
Provides a menu bar that spans the top of a Toplevel View with drop-down and cascading menus. By default, any sub-sub-menus (sub-menus of the MenuItems added to MenuBarItems) are displayed in a cascading manner, where each sub-sub-menu pops out of the sub-menu frame (either to the right or left, depending on where the sub-menu is relative to the edge of the screen). By setting MenuBar.UseSubMenusSingleFrame to true, this behavior can be changed such that all sub-sub-menus are drawn within a single frame below the MenuBar.
File Edit About (Top-Level)
MenuBarItemv2
A Shortcut-derived object to be used as items in a MenuBarv2. MenuBarItems hold a MenuBarItemv2.PopoverMenu instead of a MenuBarItemv2.SubMenu.
Shortcut Shortcut help F1
MenuBarv2
A horizontal list of MenuBarItemv2s. Each MenuBarItemv2 can have a PopoverMenu that is shown when the MenuBarItemv2 is selected.
File Edit Help
MenuItemv2
A Shortcut-derived object to be used as a menu item in a Menuv2. Has title, an A Shortcut-derived object to be used as a menu item in a Menuv2. Has title, an associated help text, and an action to execute on activation.
Shortcut Shortcut help F1
Menuv2
A Bar-derived object to be used as a vertically-oriented menu. Each subview is a MenuItemv2.
┌─────────────────────────┐
│ Quit Quit Ctrl+Z │
│ Help Help Text F1 │
│ ☐ Check Czech F9 │
└─────────────────────────┘
NumericUpDown
Enables the user to increase or decrease an int by clicking on the up or down buttons.
▼0▲
NumericUpDown<T>
Enables the user to increase or decrease a value with the mouse or keyboard in type-safe way.
OpenDialog
Provides an interactive Dialog for selecting files or directories for opening
┏┥Open┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃C:\Users\Tig\s\gui-cs\Terminal.Gui\doc┃
┃⟦▲⟧ ┃
┃┌────────────────────┬───────────────┐┃
┃│Filename (▲) │Size │┃
┃├────────────────────┼───────────────►┃
┃│.. │ │┃
┃│\_exported_templates│ │┃
┃│\_site │ │┃
┃│\api │ │┃
┃│\docs │ │┃
┃│\images │ │┃
┃│\schemas │ │┃
┃│\scripts │ │┃
┃⟦ ►► ⟧ Enter Search⟦► OK ◄⟧ ⟦ Cancel ⟧┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
OptionSelector
Provides a user interface for displaying and selecting a single item from a list of options. Each option is represented by a checkbox, but only one can be selected at a time.
○ Option 1
○ Option 2
○ Third Option
○ Option Quattro
PopoverMenu
Provides a cascading menu that pops over all other content. Can be used as a context menu or a drop-down all other content. Can be used as a context menu or a drop-down menu as part of MenuBarv2 as part of MenuBarv2.
ProgressBar
A Progress Bar view that can indicate progress of an activity visually.
▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌
RadioGroup
Displays a list of mutually-exclusive items. Each items can have its own hotkey.
◉ Option 1
○ Option 2
○ Option 3
SaveDialog
Provides an interactive Dialog for selecting files or directories for saving
┏┥Save┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃C:\Users\Tig\s\gui-cs\Terminal.Gui\doc┃
┃⟦▲⟧ ┃
┃┌────────────────────┬───────────────┐┃
┃│Filename (▲) │Size │┃
┃├────────────────────┼───────────────►┃
┃│.. │ │┃
┃│\_exported_templates│ │┃
┃│\_site │ │┃
┃│\api │ │┃
┃│\docs │ │┃
┃│\images │ │┃
┃│\schemas │ │┃
┃│\scripts │ │┃
┃⟦ ►► ⟧ Enter Sear⟦► Save ◄⟧ ⟦ Cancel ⟧┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
ScrollBar
Indicates the size of scrollable content and controls the position of the visible content, either vertically or horizontally. Two Buttons are provided, one to scroll up or left and one to scroll down or right. Between the buttons is a ScrollSlider that can be dragged to control the position of the visible content. The ScrollSlier is sized to show the proportion of the scrollable content to the size of the View.Viewport.
▲
█
░
░
░
░
░
░
░
░
░
░
░
░
░
░
░
░
░
▼
ScrollSlider
Represents the proportion of the visible content to the Viewport in a ScrollBar. Can be dragged with the mouse, constrained by the size of the Viewport of it's superview. Can be oriented either vertically or horizontally.
██████████████████████████████████████████████████
██████████████████████████████████████████████████
██████████████████████████████████████████████████
██████████████████████████████████████████████████
██████████████████████████████████████████████████
Shortcut
Displays a command, help text, and a key binding. When the key specified by Shortcut.Key is pressed, the command will be invoked. Useful for displaying a command in Bar such as a menu, toolbar, or status bar.
Shortcut Shortcut help F1
Slider
Provides a slider control letting the user navigate from a set of typed options in a linear manner using the keyboard or mouse.
●
Demo Text
Slider<T>
Provides a tpe-safe slider control letting the user navigate from a set of typed options in a linear manner using the keyboard or mouse.
SpinnerView
Displays a spinning glyph or combinations of glyphs to indicate progress or activity
●∙∙
StatusBar
A status bar is a View that snaps to the bottom of a Toplevel displaying set of Shortcuts. The StatusBar should be context sensitive. This means, if the main menu and an open text editor are visible, the items probably shown will be ~F1~ Help ~F2~ Save ~F3~ Load. While a dialog to ask a file to load is executed, the remaining commands will probably be ~F1~ Help. So for each context must be a new instance of a status bar.
Ctrl+Z Quit Quit │ F1 Help Text Help │ F10 ☐
Tab
A single tab in a TabView.
╭┤Demo Title├────────────────────────────────────╮
│Demo Text │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
╰────────────────────────────────────────────────╯
TableView
Displays and enables infinite scrolling through tabular data based on a ITableSource. See the TableView Deep Dive for more.
┌──────────────────┬──────────────────────┬──────┐
│StrCol │DateCol │IntCol│
├──────────────────┼──────────────────────┼──────►
│Demo text in row 0│12/25/2000 12:00:00 AM│0 │
│Demo text in row 1│12/25/2001 12:00:00 AM│0 │
│Demo text in row 2│12/25/2002 12:00:00 AM│0 │
│Demo text in row 3│12/25/2003 12:00:00 AM│2 │
│Demo text in row 4│12/25/2004 12:00:00 AM│1 │
TabView
Control that hosts multiple sub views, presenting a single one at once.
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└────────────────────────────────────────────────┘
TextField
Single-line text editor.
This is a test.
TextValidateField
Masked text editor that validates input through a ITextValidateProvider
┌┤^([0-9]?[0-9]?[0-9]|1000)$├────────────────────┐
│999 │
└────────────────────────────────────────────────┘
TextView
Fully featured multi-line text editor
TextView provides a fully featured multi-line text
It supports word wrap and history for undo.
TileView
A View consisting of a moveable bar that divides the display area into resizeable TileView.Tiles.
│
│
│
│
│
│
│
│
│
│
│
│
│
│
│
│
│
│
│
│
TimeField
Provides time editing functionality with mouse support
02:48:05
Toplevel
Toplevel views are used for both an application's main view (filling the entire screen and for modal (pop-up) views such as Dialog, MessageBox, and Wizard).
Demo Text
TreeView
Convenience implementation of generic TreeView%601 for any tree were all nodes implement ITreeNode. See TreeView Deep Dive for more information.
├-Root1
│ ├─Child1.1
│ └─Child1.2
└-Root2
├─Child2.1
└─Child2.2
TreeView<T>
Hierarchical tree view with expandable branches. Branch objects are dynamically determined when expanded using a user defined ITreeBuilder%601. See TreeView Deep Dive for more information.
Window
An overlapped container for other views with a border and optional title.
┌┤Demo Title├────────────────────────────────────┐
│Demo Text │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└────────────────────────────────────────────────┘
Wizard
Provides navigation and a user interface (UI) to collect related data across multiple steps. Each step ( WizardStep) can host arbitrary Views, much like a Dialog. Each step also has a pane for help text. Along the bottom of the Wizard view are customizable buttons enabling the user to navigate forward and backward through the Wizard.
╔╡Demo Title╞════════════════════════════╗
║Demo Text ║
║ ║
║ ║
║ ║
║ ║
║ ║
║ ║
║ ║
║ ║
║ ║
║ ║
║ ║
║ ║
║ ║
║────────────────────────────────────────║
║⟦ Back ⟧ ⟦► Finish ◄⟧║
╚════════════════════════════════════════╝
WizardStep
Represents a basic step that is displayed in a Wizard. The WizardStep view is divided horizontally in two. On the left is the content view where Views can be added, On the right is the help for the step. Set WizardStep.HelpText to set the help text. If the help text is empty the help pane will not be shown. If there are no Views added to the WizardStep the WizardStep.HelpText (if not empty) will fill the wizard step.