Terminal.Gui provides the following set of built-in views and controls for building terminal user interfaces:
Allows the user to pick an xref:Terminal.Gui.Drawing.Attribute by selecting foreground and background colors, and text styles.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊┌┤Foreground├───────────────────────────────────────────────┬┤Style├────────┐ ┊ ┊│H: ▲355 │☒ Bold │ ┊ ┊│S: ▲ 70 │☐ Faint │ ┊ ┊│V: ▲ 91 │☒ Italic │ ┊ ┊│Name: BrightRed │☐ Underline │ ┊ ┊│Hex:#E74856 ■ │☐ Blink │ ┊ ┊├┼Background┼───────────────────────────────────────────────┤☐ Reverse │ ┊ ┊│H: ▲ 240 │☐ Strikethrough│ ┊ ┊│S: ▲100 │ │ ┊ ┊│V: ▲100 │ │ ┊ ┊│Name: Blue │ │ ┊ ┊│Hex:#0000FF ■ │ │ ┊ ┊└───────────────────────────────────────────────────────────┴───────────────┘ ┊ ┊ Multi-line Sample Text. ┊ ┊ This is the second line. ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
A container for xref:Terminal.Gui.Views.Shortcut items that arranges them horizontally or vertically. Serves as the base class for xref:Terminal.Gui.Views.Menu, xref:Terminal.Gui.Views.MenuBar, and xref:Terminal.Gui.Views.StatusBar.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊ Shortcut Shortcut help F1 Help Help Text F1 ☐ Check Czech F9 ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Raises the xref:Terminal.Gui.ViewBase.View.Accepting and xref:Terminal.Gui.ViewBase.View.Accepted events when the user presses xref:Terminal.Gui.ViewBase.View.HotKey, Enter, or Space or clicks with the mouse.
┌┤Button├┄┄┐ ┊⟦ Button ⟧┊ └┄┄┄┄┄┄┄┄┄┄┘
A scrollable map of the Unicode codepoints.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊ 0 1 2 3 4 5 6 7 8 9 a b c d e f ┊ ┊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 N O ░┊ ┊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 n o ░┊ ┊U+00007_ p q r s t u v w x y z { | } ~ ⑿ ░┊ ┊U+00008_ ⒀ ⒁ ⒂ ⒃ ⒄ ⒅ ⒆ ⒇ ⒈ ⒉ ⒊ ⒋ ⒌ ⒍ ⒎ ⒏ ░┊ ┊U+00009_ ⒐ ⒑ ⒒ ⒓ ⒔ ⒕ ⒖ ⒗ ⒘ ⒙ ⒚ ⒛ ⒜ ⒝ ⒞ ⒟ ░┊ ┊U+0000a_ ¡ ¢ £ ¤ ¥ ¦ § ¨ © ª « ¬ F ® ¯ ░┊ ┊U+0000b_ ° ± ² ³ ´ µ ¶ · ¸ ¹ º » ¼ ½ ¾ ¿ ░┊ ┊U+0000c_ À Á Â Ã Ä Å Æ Ç È É Ê Ë Ì Í Î Ï ░┊ ┊U+0000d_ Ð Ñ Ò Ó Ô Õ Ö × Ø Ù Ú Û Ü Ý Þ ß ░┊ ┊U+0000e_ à á â ã ä å æ ç è é ê ë ì í î ï ░┊ ┊U+0000f_ ð ñ ò ó ô õ ö ÷ ø ù ú û ü ý þ ÿ ░┊ ┊U+00010_ Ā ā Ă ă Ą ą Ć ć Ĉ ĉ Ċ ċ Č č Ď ď ▼┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Shows a checkbox that can be cycled between two or three states.
┌┤This is some demo text.├┐ ┊☐ This is some demo text.┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Color Picker supporting RGB, HSL, and HSV color models. Supports choosing colors with sliders and color names from the xref:Terminal.Gui.Drawing.IColorNameResolver.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊H: ▲355 ┊ ┊S: ▲ 70 ┊ ┊V: ▲ 91 ┊ ┊Hex:#E74856 ■ ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
A simple color picker that supports the legacy 16 ANSI colors.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊┌┄┄┐ ┊ ┊└┄┄┘ ┊ ┊ ┊ ┊ ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Provides date editing functionality using xref:Terminal.Gui.Views.TextValidateField with culture-aware formatting.
┌┄┄┄┄┄┄┄┄┄┄┄┐ ┊01/15/2024 ┊ └┄┄┄┄┄┄┄┄┄┄┄┘
Lets the user pick a date from a visual calendar.
┌─────────────────────────────┐ │Date: 04/20/2026 │ │┌───┬───┬───┬───┬───┬───┬───┐│ ││Sun│Mon│Tue│Wed│Thu│Fri│Sat││ │├───┼───┼───┼───┼───┼───┼───┤│ ││- │- │- │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 │- │- ││ ││- │- │- │- │- │- │- ││ │└───┴───┴───┴───┴───┴───┴───┘│ │ ◄◄ ►► │ └─────────────────────────────┘
A modal dialog window with buttons across the bottom. When a button is pressed, xref:Terminal.Gui.App.IRunnable%601.Result is set to the button's index (0-based).
┏┥Dialog Title┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃Example: Type and press ENTER to accept. ▼┃ ┃ ┃ ┃ ⟦ Cancel ⟧ ⟦► OK ◄⟧┃ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
A generic modal dialog window with buttons across the bottom. Derive from this class to create dialogs that return custom result types.
A dropdown/combo-box control that combines a xref:Terminal.Gui.Views.TextField with a popover xref:Terminal.Gui.Views.ListView for selecting from a list of items.
┌┄┄┄┄┄┄┄┄┄┄┐ ┊Germany ▼┊ └┄┄┄┄┄┄┄┄┄┄┘
A type-safe dropdown control for selecting a single value from an enum. Provides the same interface as xref:Terminal.Gui.Views.OptionSelector%601 but rendered as a compact dropdown list.
The base-class for xref:Terminal.Gui.Views.OpenDialog and xref:Terminal.Gui.Views.SaveDialog
┏┥Open┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃C:\Users\Tig\s\gui-cs\Terminal.Gui\docfx ┃ ┃⟦▲⟧ ┃ ┃┌────────────────────┬──────────┬──────────────────────────────┬───────────┃ ┃│Filename (▲) │Size │Modified │Type ┃ ┃├────────────────────┼──────────┼──────────────────────────────┼───────────┃ ┃│.. │ │ │<Directory>┃ ┃│\_exported_templates│ │2026-04-09T04:42:42 │<Directory>┃ ┃│\_site │ │2026-04-20T10:45:59 │<Directory>┃ ┃│\api │ │2026-04-20T10:45:05 │<Directory>┃ ┃│\apispec │ │2026-04-09T04:42:42 │<Directory>┃ ┃│\docs │ │2026-04-20T10:42:55 │<Directory>┃ ┃│\images │ │2026-04-09T04:42:42 │<Directory>┃ ┃│\includes │ │2026-04-18T06:44:01 │<Directory>┃ ┃│\schemas │ │2026-04-09T04:42:42 │<Directory>┃ ┃│\scripts │ │2026-04-09T04:42:42 │<Directory>┃ ┃│aboutbox.png │14.06 KB │2026-04-09T04:42:42 │.png ┃ ┃ ┃ ┃⟦►Tree⟧ ⟦ Cancel ⟧⟦► OK ◄⟧┃ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
Provides a user interface for displaying and selecting non-mutually-exclusive flags from a provided dictionary. xref:Terminal.Gui.Views.FlagSelector%601 provides a type-safe version where a [Flags] enum can be provided.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊☒ No Style ┊ ┊☐ Show None Value Style ┊ ┊☐ ShowAllFlag ┊ ┊☐ Show Value Editor Style┊ ┊☐ All Styles ┊ ┊0 ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Provides a user interface for displaying and selecting non-mutually-exclusive flags in a type-safe way. xref:Terminal.Gui.Views.FlagSelector provides a non-type-safe version. TFlagsEnum must be a valid enum type with the '[Flags]' attribute.
A non-overlapped container for other views with a border and optional title.
╭──────────────────────────────────────────────────────────────────────────────╮ │This is some demo text. │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ╰──────────────────────────────────────────────────────────────────────────────╯
Displays graphs (bar, scatter, etc.) with flexible labels, scaling, and scrolling.
┌┤Sine Wave├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊ │ . ∙ ┊ ┊ ┤ ∙ . ┊ ┊ │ . .. ┊ ┊ │ .. . ┊ ┊ 0.20┤. ∙ ┊ ┊ ┬────┬────┬────┬────┬────∙────┬────┬────┬────┬────┬────┬────┬────┬────┬────┊ ┊ -2.50 -1.50 -0.50 .│ 0.50 1.50 2.50 .3.50 4.50 ┊ ┊ . │ . ┊ ┊↑ -0.20┤ . ┊ ┊Y. . │ ∙ ┊ ┊ . ∙ ┤ . ┊ ┊ ∙ . │ .. ┊ ┊ . .. -0.60┤ . ┊ ┊ .. . │ ∙. ┊ ┊ . ..∙ ┤ .. ┊ ┊ ∙....∙.. -1.00┤ .∙....┊ ┊ ┊ ┊ X → ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
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 ┊ 64 61 74 61 HexView data ┊ ┊0000000c 20 77 69 74 ┊ 68 20 77 69 ┊ 64 65 20 63 with wide c ┊ ┊00000018 6f 64 65 70 ┊ 6f 69 6e 74 ┊ 73 3a 20 f0 odepoints: � ┊ ┊00000024 9d 94 b9 41 ┊ e2 84 9d f0 ┊ 9d 94 bd 21 ���A�������! ┊ ┊00000030 ┊ ┊ ┊ ┊0000003c ┊ ┊ ┊ ┊00000048 ┊ ┊ ┊ ┊00000054 ┊ ┊ ┊ ┊00000060 ┊ ┊ ┊ ┊0000006c ┊ ┊ ┊ ┊00000078 ┊ ┊ ┊ ┊00000084 ┊ ┊ ┊ ┊00000090 ┊ ┊ ┊ ┊0000009c ┊ ┊ ┊ ┊000000a8 ┊ ┊ ┊ ┊000000b4 ┊ ┊ ┊ ┊000000c0 ┊ ┊ ┊ ┊000000cc ┊ ┊ ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Displays text that describes the View next in the xref:Terminal.Gui.ViewBase.View.SubViews. When the user presses a hotkey that matches the xref:Terminal.Gui.ViewBase.View.HotKey of the Label, the next xref:Terminal.Gui.ViewBase.View in xref:Terminal.Gui.ViewBase.View.SubViews will be activated.
┌┤Lab├┐ ┊Label┊ └┄┄┄┄┄┘
Used by xref:Terminal.Gui.Views.GraphView to render symbol definitions in a graph, e.g. colors and their meanings
┌──────────────────────────────────────────────────────────────────────────────┐ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ └──────────────────────────────────────────────────────────────────────────────┘
Draws a single line using the xref:Terminal.Gui.Drawing.LineStyle specified by xref:Terminal.Gui.Views.Line.Style.
┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄
Provides a linear range control letting the user navigate from a set of typed options in a linear manner using the keyboard or mouse.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊ ● ┊ ┊This is some demo text.┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Provides a type-safe linear range control letting the user navigate from a set of typed options in a linear manner using the keyboard or mouse.
Displays a clickable hyperlink with optional display text and a target URL.
┌┤Link├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊https://github.com/gui-cs┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Provides a scrollable list of data where each item can be activated to perform an action.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊List Item 1 ┊ ┊List Item two ┊ ┊List Item 3 ┊ ┊List Item Quattro ┊ ┊Last List Item ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Provides a scrollable list of data where each item can be activated to perform an action, with a strongly-typed xref:Terminal.Gui.Views.ListView%601.Value property that returns the selected object of type T from the underlying xref:System.Collections.ObjectModel.ObservableCollection%601.
A read-only view that renders Markdown-formatted text with styled headings, lists, links, code blocks, and more.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊# Terminal.GuiMarkdown Sample 🚀 ▲┊ ┊ █┊ ┊Rich text with bold, italic, inline code, and strikethrough. █┊ ┊ █┊ ┊## Links & Images ░┊ ┊ ░┊ ┊API Docs: ░┊ ┊ ░┊ ┊• Markdown for more info. ░┊ ┊• MarkdownTable for more info. ░┊ ┊• MarkdownCodeBlock for more info. ░┊ ┊ ░┊ ┊## Checklist ░┊ ┊ ░┊ ┊• [x] Bold & italic ✅ ░┊ ┊• [x] Code blocks 🔧 ░┊ ┊• [ ] Emojis 🎉 ░┊ ┊ ▼┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
A read-only view that renders a single Markdown fenced code block with a dimmed background and an optional copy button.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊using IApplication app = Application.Create⧉(┊ ┊app.Init (); ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
A read-only view that renders a single Markdown table with box-drawing borders via xref:Terminal.Gui.Drawing.LineCanvas and styled header/body text with inline Markdown formatting.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊┌──────────┬─────────────────────────┬────────────────────────────────────────┼ ┊│ Feature │ Status (centered) │ Owner ┊ ┊├──────────┼─────────────────────────┼────────────────────────────────────────┼ ┊│ Markdown │ ✅ Totally! │ @tig ┊ ┊│ Tables │ ✅ For sure! │ tig ┊ └┼┄┄┄┄┄┄┄┄┄┄┼┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┼┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
A vertically-oriented xref:Terminal.Gui.Views.Bar that contains xref:Terminal.Gui.Views.MenuItem items, supporting cascading sub-menus, selection tracking, and the xref:Terminal.Gui.ViewBase.IValue%601 pattern.
┌────────────────────────────────────┐ │ Format Text formatting options ► ┌ │ View View options ► │ ├────────────────────────────────────│ │ About About this demo │ └────────────────────────────────────└
A horizontal xref:Terminal.Gui.Views.Menu that contains xref:Terminal.Gui.Views.MenuBarItem items. Each xref:Terminal.Gui.Views.MenuBarItem owns a xref:Terminal.Gui.Views.PopoverMenu that is displayed as a drop-down when the item is selected. Typically placed at the top of a window or view.
File Edit Help
A xref:Terminal.Gui.Views.MenuItem-derived item for use in a xref:Terminal.Gui.Views.MenuBar. Each xref:Terminal.Gui.Views.MenuBarItem holds either a xref:Terminal.Gui.Views.MenuBarItem.PopoverMenu (modal, default) or an inline xref:Terminal.Gui.Views.MenuItem.SubMenu (non-modal) that is displayed as a drop-down menu when the item is selected. The behavior is controlled by the xref:Terminal.Gui.Views.MenuBarItem.UsePopoverMenu property.
┌┄┄┐ ┊ ┊ └┄┄┘
A xref:Terminal.Gui.Views.Shortcut-derived item for use in a xref:Terminal.Gui.Views.Menu. Displays a command, help text, and key binding and supports nested xref:Terminal.Gui.Views.MenuItem.SubMenus for cascading menu hierarchies.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊ Shortcut Shortcut help F1 ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Enables the user to increase or decrease an int by clicking on the up or down buttons.
┌┄┄┄┐ ┊▼0▲┊ └┄┄┄┘
Enables the user to increase or decrease a value with the mouse or keyboard in type-safe way.
Provides an interactive xref:Terminal.Gui.Views.Dialog for selecting files or directories for opening
┏┥Open┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃C:\Users\Tig\s\gui-cs\Terminal.Gui\docfx ┃ ┃⟦▲⟧ ┃ ┃┌────────────────────┬──────────┬──────────────────────────────┬───────────┃ ┃│Filename (▲) │Size │Modified │Type ┃ ┃├────────────────────┼──────────┼──────────────────────────────┼───────────┃ ┃│.. │ │ │<Directory>┃ ┃│\_exported_templates│ │2026-04-09T04:42:42 │<Directory>┃ ┃│\_site │ │2026-04-20T10:45:59 │<Directory>┃ ┃│\api │ │2026-04-20T10:45:05 │<Directory>┃ ┃│\apispec │ │2026-04-09T04:42:42 │<Directory>┃ ┃│\docs │ │2026-04-20T10:42:55 │<Directory>┃ ┃│\images │ │2026-04-09T04:42:42 │<Directory>┃ ┃│\includes │ │2026-04-18T06:44:01 │<Directory>┃ ┃│\schemas │ │2026-04-09T04:42:42 │<Directory>┃ ┃│\scripts │ │2026-04-09T04:42:42 │<Directory>┃ ┃│aboutbox.png │14.06 KB │2026-04-09T04:42:42 │.png ┃ ┃ ┃ ┃⟦►Tree⟧ ⟦ Cancel ⟧⟦► OK ◄⟧┃ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
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. xref:Terminal.Gui.Views.OptionSelector%601 provides a type-safe version where a enum can be provided.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊◉ Option 1 ┊ ┊○ Option 2 ┊ ┊○ Third Option ┊ ┊○ Option Quattro┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Provides a user interface for displaying and selecting a single item from a list of options in a type-safe way. Each option is represented by a checkbox, but only one can be selected at a time. xref:Terminal.Gui.Views.OptionSelector provides a non-type-safe version.
A xref:Terminal.Gui.App.IPopover-derived view that provides a cascading menu. Can be used as a context menu or a drop-down menu as part of xref:Terminal.Gui.Views.MenuBar.
A Progress Bar view that can indicate progress of an activity visually.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌ ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
A dialog that wraps any xref:Terminal.Gui.ViewBase.View with Ok/Cancel buttons, extracting a typed result when the user accepts.
Base implementation of xref:Terminal.Gui.App.IRunnable for views that can be run as blocking sessions without returning a result.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐
┊This is some demo text. ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
└┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Base implementation of xref:Terminal.Gui.App.IRunnable%601 for views that can be run as blocking sessions.
Wraps any xref:Terminal.Gui.ViewBase.View to make it runnable with a typed result without adding dialog buttons.
Provides an interactive xref:Terminal.Gui.Views.Dialog for selecting files or directories for saving
┏┥Save┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃C:\Users\Tig\s\gui-cs\Terminal.Gui\docfx ┃ ┃⟦▲⟧ ┃ ┃┌────────────────────┬──────────┬──────────────────────────────┬───────────┃ ┃│Filename (▲) │Size │Modified │Type ┃ ┃├────────────────────┼──────────┼──────────────────────────────┼───────────┃ ┃│.. │ │ │<Directory>┃ ┃│\_exported_templates│ │2026-04-09T04:42:42 │<Directory>┃ ┃│\_site │ │2026-04-20T10:45:59 │<Directory>┃ ┃│\api │ │2026-04-20T10:45:05 │<Directory>┃ ┃│\apispec │ │2026-04-09T04:42:42 │<Directory>┃ ┃│\docs │ │2026-04-20T10:42:55 │<Directory>┃ ┃│\images │ │2026-04-09T04:42:42 │<Directory>┃ ┃│\includes │ │2026-04-18T06:44:01 │<Directory>┃ ┃│\schemas │ │2026-04-09T04:42:42 │<Directory>┃ ┃│\scripts │ │2026-04-09T04:42:42 │<Directory>┃ ┃│aboutbox.png │14.06 KB │2026-04-09T04:42:42 │.png ┃ ┃ ┃ ┃⟦►Tree⟧ ⟦ Cancel ⟧⟦► Save ◄⟧┃ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
Indicates the size of scrollable content and controls the position of the visible content, either vertically or horizontally. Two xref:Terminal.Gui.Views.Buttons are provided, one to scroll up or left and one to scroll down or right. Between the buttons is a xref:Terminal.Gui.Views.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 xref:Terminal.Gui.ViewBase.View.Viewport.
┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊
A xref:Terminal.Gui.Views.Button used to scroll content forward or backward. It enables mouse hold-repeat for continuous scrolling when the mouse button is held down. The button displays an arrow glyph determined by the combination of xref:Terminal.Gui.Views.ScrollButton.Direction and xref:Terminal.Gui.Views.ScrollButton.Orientation:
| Orientation | Direction | Glyph |
|---|---|---|
| Horizontal | Backward | xref:Terminal.Gui.Drawing.Glyphs.LeftArrow |
| Horizontal | Forward | xref:Terminal.Gui.Drawing.Glyphs.RightArrow |
| Vertical | Backward | xref:Terminal.Gui.Drawing.Glyphs.UpArrow |
| Vertical | Forward | xref:Terminal.Gui.Drawing.Glyphs.DownArrow |
┌┤Butt├┐ ┊Button┊ └┄┄┄┄┄┄┘
Represents the proportion of the visible content to the Viewport in a xref:Terminal.Gui.Views.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.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊██████████████████████████████████████████████████████████████████████████████┊ ┊██████████████████████████████████████████████████████████████████████████████┊ ┊██████████████████████████████████████████████████████████████████████████████┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
The abstract base class for xref:Terminal.Gui.Views.OptionSelector%601 and xref:Terminal.Gui.Views.FlagSelector%601.
Displays a command, help text, and a key binding. Serves as the foundational building block for xref:Terminal.Gui.Views.Bar, xref:Terminal.Gui.Views.Menu, xref:Terminal.Gui.Views.MenuBar, and xref:Terminal.Gui.Views.StatusBar.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊ Shortcut Shortcut help F1 ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Displays a spinning glyph or combinations of glyphs to indicate progress or activity
┌┄┐ ┊●┊ └┄┘
A status bar is a xref:Terminal.Gui.ViewBase.View that snaps to the bottom of the Viewport displaying set of xref:Terminal.Gui.Views.Shortcuts. The xref:Terminal.Gui.Views.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 ☐ Show/Hide │⟦ I'll Hide ⟧│Focu
Displays and enables infinite scrolling through tabular data based on a xref:Terminal.Gui.Views.ITableSource. See the TableView Deep Dive for more.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊┌──────────────────┬──────────────────────┬──────┬───────────────────┬────────┊ ┊│StrCol │DateCol │IntCol│DoubleCol │NullsCol┊ ┊├──────────────────┼──────────────────────┼──────┼───────────────────┼────────┊ ┊│Demo text in row 0│12/25/2000 12:00:00 AM│0 │-0.5 │- ┊ ┊│Demo text in row 1│12/25/2001 12:00:00 AM│0 │0.40245424998107093│- ┊ ┊│Demo text in row 2│12/25/2002 12:00:00 AM│0 │1.3973309257520972 │- ┊ ┊│Demo text in row 3│12/25/2003 12:00:00 AM│2 │1.3318544644079424 │- ┊ ┊│Demo text in row 4│12/25/2004 12:00:00 AM│1 │0.09525688765349649│- ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
A tabbed container xref:Terminal.Gui.ViewBase.View that renders each SubView as a selectable tab with a header drawn by xref:Terminal.Gui.ViewBase.Border. The currently focused SubView is the selected (front-most) tab.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊╭─────────╮──────────╮────────────╮──────────╮ ┊ ┊│Attribute│Line Style│Tab Settings│Add/Remove│ ┊ ┊│ ╰──────────┴────────────┴──────────┴───────────────────────────────╮┊ ┊│ │┊ ┊│┌──────────────────────────────────────────────────────────────────────────┐│┊ ┊││┌┤Foreground├───────────────────────────────────────────┬┤Style├────────┐ ││┊ ┊│││H:▲ 0 │☐ Bold │ ││┊ ┊│││S:▲ 0 │☐ Faint │ ││┊ ┊│││V: ▲100 │☐ Italic │ ││┊ ┊│││Name: White │☐ Underline │ ││┊ ┊│││Hex:#FFFFFF ■ │☐ Blink │ ││┊ ┊││├┼Background┼───────────────────────────────────────────┤☐ Reverse │ ││┊ ┊│││H:▲ 0 │☐ Strikethrough│ ││┊ ┊│││S:▲ 0 │ │ ││┊ ┊│││V:▲ 0 │ │ ││┊ ┊│││Name: Black │ │ ││┊ ┊│││Hex:#000000 ■ │ │ ││┊ ┊╰────────────────────────────────────────────────────────────────────────────╯┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Single-line text editor.
┌┤Caption├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊This is a test. ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Masked text editor that validates input through a xref:Terminal.Gui.Views.ITextValidateProvider.
┌┤^([0-9]?[0-9]?[0-9]|1000)$├──────────────────────────────────────────────────┐ │999 │ └──────────────────────────────────────────────────────────────────────────────┘
Fully featured multi-line text editor.
┌┐ └┘
Provides time editing functionality using xref:Terminal.Gui.Views.TextValidateField with culture-aware formatting.
┌┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊02:30:00 PM ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┘
Convenience implementation of generic xref:Terminal.Gui.Views.TreeView%601 for any tree were all nodes implement xref:Terminal.Gui.Views.ITreeNode. See TreeView Deep Dive for more information.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊├-Root1 ┊ ┊│ ├─Child1.1 ┊ ┊│ └─Child1.2 ┊ ┊└-Root2 ┊ ┊ ├-Child2.1 ┊ ┊ │ ├─Child2.1.1 ┊ ┊ │ └─Child2.1.2 ┊ ┊ └─Child2.2 ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Hierarchical tree view with expandable branches. Branch objects are dynamically determined when expanded using a user defined xref:Terminal.Gui.Views.ITreeBuilder%601. See TreeView Deep Dive for more information.
An overlapped container for other views with a border and optional title.
┌──────────────────────────────────────────────────────────────────────────────┐
│This is some demo text. │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└──────────────────────────────────────────────────────────────────────────────┘
A multi-step dialog for collecting related data across sequential steps.
┌┤Wizard Title - Example Step├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊Enter Text: This is some help text ┊ ┊ for the WizardStep. ┊ ┊ A List: ┌╌╌╌╌╌╌╌╌┐ You can provide ┊ ┊ ┆Item 1 ┆ instructions or ┊ ┊ ┆Item 2 ┆ information to guide the┊ ┊ ┆Item 3 ┆ user through this step ┊ ┊ ┆Item 4 ┆ of the wizard. ┊ ┊ ┆Item 5 ┆ ┊ ┊ └╌╌╌╌╌╌╌╌┘ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ⟦► Next... ◄⟧┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
A single step in a xref:Terminal.Gui.Views.Wizard. Can contain arbitrary xref:Terminal.Gui.ViewBase.Views and display help text in the right xref:Terminal.Gui.ViewBase.Padding.
┌┤Example Step├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊Enter Text: This is some help text ┊ ┊ for the WizardStep. ┊ ┊ A List: ┌╌╌╌╌╌╌╌╌┐ You can provide ┊ ┊ ┆Item 1 ┆ instructions or ┊ ┊ ┆Item 2 ┆ information to guide the┊ ┊ ┆Item 3 ┆ user through this step ┊ ┊ ┆Item 4 ┆ of the wizard. ┊ ┊ ┆Item 5 ┆ ┊ ┊ └╌╌╌╌╌╌╌╌┘ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘