Terminal Gui's Built-in Views
Terminal.Gui provides the following set of built-in views and controls for building terminal user interfaces:
AttributePicker
Allows the user to pick an 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. ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Bar
Provides a horizontally or vertically oriented container for Shortcuts to be used as a menu, toolbar, or status bar.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊ Shortcut Shortcut help F1 Help Help Text F1 ☐ Check Czech F9 ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Button
Raises the Accepting and Accepted events when the user presses HotKey, Enter, or Space or clicks with the mouse.
┌┤Button├┄┄┐ ┊⟦ Button ⟧┊ └┄┄┄┄┄┄┄┄┄┄┘
CharMap
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_ Ā ā Ă ă Ą ą Ć ć Ĉ ĉ Ċ ċ Č č Ď ď ▼┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
CheckBox
Shows a checkbox that can be cycled between two or three states.
┌┤This is some demo text.├┐ ┊☐ This is some demo text.┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
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 specialized cursor behavior for date entry.
┌┤Caption├┄┐ ┊1/01/0001 ┊ └┄┄┄┄┄┄┄┄┄┄┘
DatePicker
Lets the user pick a date from a visual calendar.
┌────────────────────────────┐ │Date: 02/25/2026 │ │┌───┬───┬───┬───┬───┬───┬──┐│ ││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││ ││- │- │- │- │- │- │- ││ ││- │- │- │- │- │- │- ││ │└───┴───┴───┴───┴───┴───┴──┘│ │ ◄◄ ►► │ └────────────────────────────┘
Dialog<T>
A generic modal dialog window with buttons across the bottom. Derive from this class to create dialogs that return custom result types.
Dialog
A modal dialog window with buttons across the bottom. When a button is pressed, Result is set to the button's index (0-based).
┏┥Dialog Title┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃◄█████████████████████████████████████████████░► ┃ ┃ ┃ ┃ ⟦ Cancel ⟧ ⟦► OK ◄⟧┃ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
FileDialog
The base-class for OpenDialog and SaveDialog
┏┥Open┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃D:\s\gui-cs\Terminal.Gui\.claude\worktrees\docfx-views-fix\docfx ┃ ┃⟦▲⟧ ┃ ┃┌────────────────────┬──────────┬─────────────────────────────────────────┐┃ ┃│Filename (▲) │Size │Modified │┃ ┃├────────────────────┼──────────┼─────────────────────────────────────────►┃ ┃│.. │ │ │┃ ┃│\_exported_templates│ │2026-02-25T09:13:54 │┃ ┃│\api │ │2026-02-25T09:15:30 │┃ ┃│\apispec │ │2026-02-25T09:13:54 │┃ ┃│\docs │ │2026-02-25T09:13:54 │┃ ┃│\images │ │2026-02-25T09:13:54 │┃ ┃│\includes │ │2026-02-25T09:13:54 │┃ ┃│\schemas │ │2026-02-25T09:13:54 │┃ ┃│\scripts │ │2026-02-25T09:14:22 │┃ ┃│aboutbox.png │14.06 KB │2026-02-25T09:13:54 │┃ ┃│docfx.json │2.01 KB │2026-02-25T09:13:54 │┃ ┃ ┃ ┃⟦►Tree⟧ ⟦ Cancel ⟧⟦► OK ◄⟧┃ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
FlagSelector<T>
Provides a user interface for displaying and selecting non-mutually-exclusive flags in a type-safe way. FlagSelector provides a non-type-safe version. TFlagsEnum must be a valid enum type with the '[Flags]' attribute.
FlagSelector
Provides a user interface for displaying and selecting non-mutually-exclusive flags from a provided dictionary. FlagSelector<TFlagsEnum> 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 ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
FrameView
A non-overlapped container for other views with a border and optional title.
╭──────────────────────────────────────────────────────────────────────────────╮ │This is some demo text. │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ╰──────────────────────────────────────────────────────────────────────────────╯
GraphView
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 → ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
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 ┊ 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 ┊ ┊ ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Label
Displays text that describes the View next in the SubViews. When the user presses a hotkey that matches the HotKey of the Label, the next View in SubViews will be activated.
┌┤Lab├┐ ┊Label┊ └┄┄┄┄┄┘
LegendAnnotation
Used by GraphView to render symbol definitions in a graph, e.g. colors and their meanings
┌──────────────────────────────────────────────────────────────────────────────┐ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ └──────────────────────────────────────────────────────────────────────────────┘
Line
Draws a single line using the LineStyle specified by Style.
┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄
LinearRange<T>
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.
LinearRange
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.┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
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 3 ┊ ┊List Item Quattro ┊ ┊Last List Item ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Menu
A Bar-derived object to be used as a vertically-oriented menu. Each subview is a MenuItem.
┌────────────────────────────────────┐ │ Format Text formatting options ► ┌ │ View View options ► │ ├────────────────────────────────────│ │ About About this demo │ └────────────────────────────────────└
MenuBar
A horizontal list of MenuBarItems. Each MenuBarItem can have a PopoverMenu that is shown when the MenuBarItem is selected.
File Edit Help
MenuBarItem
A Shortcut-derived object to be used as items in a MenuBar. MenuBarItems hold a PopoverMenu instead of a SubMenu.
┌┄┄┐ ┊ ┊ └┄┄┘
MenuItem
A Shortcut-derived object to be used as a menu item in a Menu. Has title, an associated help text, and an action to execute on activation.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊ Shortcut Shortcut help F1 ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
NumericUpDown<T>
Enables the user to increase or decrease a value with the mouse or keyboard in type-safe way.
NumericUpDown
Enables the user to increase or decrease an int by clicking on the up or down buttons.
┌┄┄┄┐ ┊▼0▲┊ └┄┄┄┘
OpenDialog
Provides an interactive Dialog for selecting files or directories for opening
┏┥Open┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃D:\s\gui-cs\Terminal.Gui\.claude\worktrees\docfx-views-fix\docfx ┃ ┃⟦▲⟧ ┃ ┃┌────────────────────┬──────────┬─────────────────────────────────────────┐┃ ┃│Filename (▲) │Size │Modified │┃ ┃├────────────────────┼──────────┼─────────────────────────────────────────►┃ ┃│.. │ │ │┃ ┃│\_exported_templates│ │2026-02-25T09:13:54 │┃ ┃│\api │ │2026-02-25T09:15:30 │┃ ┃│\apispec │ │2026-02-25T09:13:54 │┃ ┃│\docs │ │2026-02-25T09:13:54 │┃ ┃│\images │ │2026-02-25T09:13:54 │┃ ┃│\includes │ │2026-02-25T09:13:54 │┃ ┃│\schemas │ │2026-02-25T09:13:54 │┃ ┃│\scripts │ │2026-02-25T09:14:22 │┃ ┃│aboutbox.png │14.06 KB │2026-02-25T09:13:54 │┃ ┃│docfx.json │2.01 KB │2026-02-25T09:13:54 │┃ ┃ ┃ ┃⟦►Tree⟧ ⟦ Cancel ⟧⟦► OK ◄⟧┃ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
OptionSelector<T>
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. OptionSelector provides a non-type-safe version.
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. OptionSelector<TEnum> provides a type-safe version where a enum can be provided.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊◉ Option 1 ┊ ┊○ Option 2 ┊ ┊○ Third Option ┊ ┊○ Option Quattro┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
PopoverMenu
A IPopover-derived view that provides a cascading menu. Can be used as a context menu or a drop-down menu as part of MenuBar.
ProgressBar
A Progress Bar view that can indicate progress of an activity visually.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌▌ ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Prompt<T>
A dialog that wraps any View with Ok/Cancel buttons, extracting a typed result when the user accepts.
Runnable<T>
Base implementation of IRunnable<TResult> for views that can be run as blocking sessions.
Runnable
Base implementation of IRunnable for views that can be run as blocking sessions without returning a result.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐
┊This is some demo text. ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
┊ ┊
└┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
SaveDialog
Provides an interactive Dialog for selecting files or directories for saving
┏┥Save┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃D:\s\gui-cs\Terminal.Gui\.claude\worktrees\docfx-views-fix\docfx ┃ ┃⟦▲⟧ ┃ ┃┌────────────────────┬──────────┬─────────────────────────────────────────┐┃ ┃│Filename (▲) │Size │Modified │┃ ┃├────────────────────┼──────────┼─────────────────────────────────────────►┃ ┃│.. │ │ │┃ ┃│\_exported_templates│ │2026-02-25T09:13:54 │┃ ┃│\api │ │2026-02-25T09:15:30 │┃ ┃│\apispec │ │2026-02-25T09:13:54 │┃ ┃│\docs │ │2026-02-25T09:13:54 │┃ ┃│\images │ │2026-02-25T09:13:54 │┃ ┃│\includes │ │2026-02-25T09:13:54 │┃ ┃│\schemas │ │2026-02-25T09:13:54 │┃ ┃│\scripts │ │2026-02-25T09:14:22 │┃ ┃│aboutbox.png │14.06 KB │2026-02-25T09:13:54 │┃ ┃│docfx.json │2.01 KB │2026-02-25T09:13:54 │┃ ┃ ┃ ┃⟦►Tree⟧ ⟦ Cancel ⟧⟦► Save ◄⟧┃ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
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 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.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊██████████████████████████████████████████████████████████████████████████████┊ ┊██████████████████████████████████████████████████████████████████████████████┊ ┊██████████████████████████████████████████████████████████████████████████████┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
SelectorBase
The abstract base class for OptionSelector<TEnum> and FlagSelector<TFlagsEnum>.
Shortcut
Displays a command, help text, and a key binding. When the key specified by 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 ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
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 the Viewport 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 ☐ Show/Hide │⟦ I'll Hide ⟧│Focu
Tab
A single tab in a TabView.
╭──────────────────────────────────────────────────────────────────────────────╮ │This is some 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│DoubleCol │┊ ┊├──────────────────┼──────────────────────┼──────┼───────────────────────────►┊ ┊│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 │┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
TabView
Control that hosts multiple sub views, presenting a single one at once.
┌┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊ ┊ ┊ ┊ ┊ ┊ ┊│ │┊ ┊│ │┊ ┊│ │┊ ┊│ │┊ ┊│ │┊ ┊│ │┊ ┊│ │┊ ┊│ │┊ ┊│ │┊ ┊│ │┊ ┊│ │┊ ┊│ │┊ ┊│ │┊ ┊│ │┊ ┊└────────────────────────────────────────────────────────────────────────────┘┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
TextField
Single-line text editor.
┌┤Caption├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐ ┊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 editor. ┊ ┊It supports word wrap and history for undo. ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
TimeField
Provides time editing functionality with specialized cursor behavior for time entry.
┌┤Captio├┐ ┊2:48:05 ┊ └┄┄┄┄┄┄┄┄┘
TreeView<T>
Hierarchical tree view with expandable branches. Branch objects are dynamically determined when expanded using a user defined ITreeBuilder<T>. See TreeView Deep Dive for more information.
TreeView
Convenience implementation of generic TreeView<T> 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 ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
Window
An overlapped container for other views with a border and optional title.
┌──────────────────────────────────────────────────────────────────────────────┐
│This is some demo text. │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└──────────────────────────────────────────────────────────────────────────────┘
Wizard
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... ◄⟧┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘
WizardStep
A single step in a Wizard. Can contain arbitrary Views and display help text in the right 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 ┆ ┊ ┊ └╌╌╌╌╌╌╌╌┘ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ ┊ └┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┘