PromptPlus
# PromptPlus
## **PromptPlus — Documentation Index**
[](https://www.nuget.org/packages/PromptPlus)
[](https://opensource.org/licenses/MIT)
[](https://dotnet.microsoft.com/)
← Back to Home • Next: Getting Started →
Everything you need to use PromptPlus, organized by topic.
Reference Pages
| Page | What you will find |
|---|---|
| Getting Started | Prerequisites, install, first complete app, config round-trip |
| Core Concepts | The mental model — entry points, lifecycle, ResultPrompt<T>, config layers, styling |
| Architecture | Entry points, control lifecycle, ResultPrompt<T>, two config layers |
| Global Behaviors | Full IPromptPlusConfig property table, HotKey, ToFile(), per-control overrides |
| Keyboard Bindings | Emacs shortcuts, physical key reference by category |
| Visual Symbols | Symbol catalog — characters, where shown, configurability |
| Spinners | The SpinnersType catalog, visual samples, and Unicode/ASCII portability |
| Global Styles | The Style API, per-control .Styles(), and ContrastRatio |
| Widgets | Output-only widgets: Slider, Calendar, Switch, Banner, Dash, ChartBar |
| Demo Mode | Scripted keyboard input for recording GIFs/videos of console apps, and the redirected-input guard exception |
Control Pages
Every control has its own folder with four pages: an overview (index), a full methods reference,
an operations guide (keyboard, validation, history), and a styles page.
| Control | Page |
|---|---|
Input |
controls/input/ |
Secret |
controls/secret/ |
KeyPress |
controls/keypress/ |
Confirm |
controls/confirm/ |
Select<T> |
controls/select/ |
MultiSelect<T> |
controls/multiselect/ |
MaskEdit family (MaskEdit, MaskInteger, MaskLong, MaskDecimal, MaskDecimalCurrency, MaskDouble, MaskDoubleCurrency, MaskDateTime, MaskDate, MaskDateOnly, MaskTime, MaskTimeOnly) |
controls/maskedit/ |
Calendar |
controls/calendar/ |
Slider |
controls/slider/ |
Switch |
controls/switch/ |
ProgressBar |
controls/progressbar/ |
Task |
controls/task/ |
MultiTasks |
controls/multitasks/ |
Timer |
controls/timer/ |
TableSelect<T> |
controls/tableselect/ |
TableMultiSelect<T> |
controls/tablemultiselect/ |
TreeSelect<T> |
controls/treeselect/ |
TreeMultiSelect<T> |
controls/treemultiselect/ |
File |
controls/file/ |
MultiFile |
controls/multifile/ |
ChartBar |
controls/chartbar/ |
PromptPlus.Controls also exposes History(filename): IHistory, a lower-level factory for reading/
writing a control’s persisted history file directly (outside the usual .EnableHistory(filename)
fluent call on Input/Secret/Select/MultiSelect/etc.) — it has no dedicated hand-written guide yet;
see the generated IHistory reference.
API Reference
| Page | Description |
|---|---|
| API Documentation | Full auto-generated reference for all types |
Migration
| Guide | What you will find |
|---|---|
| Migration Guide v5.x → v6.x | Breaking changes, renamed controls and methods, removed APIs, and new features — overview for all controls |
| Input / AutoComplete | AutoComplete() (non-generic) → Input().SuggestionHandler(...), async additions |
| Select / MultiSelect | Renamed methods, HideCountSelected removed, async additions |
| KeyPress / Confirm | AddKeyValid → AddValidKey, timeout/countdown removed |
| TableSelect / TableMultiSelect | AddColumn reformulated, Filter signature, new features |
| TreeSelect / TreeMultiSelect | Factory renames, tree-building API reworked (Root/AddLast), remote-control removal |
| File / MultiFile | Factory renames, attribute methods, new MultiFile features |
| MultiTasks / Timer / Task | Factory renames, AddTask reformulated, return types |
| MaskEdit (all types) | No breaking changes; PredicateSelectedAsync added (factories unchanged) |
| Slider / Calendar / Switch / ProgressBar / ChartBar / History | Mostly additions; breaking changes in ProgressBar and ChartBar |
See also
- README — project overview and quick start
- Getting Started — recommended first read
- Architecture — understand the design before diving into controls
- Migration Guide v5.x → v6.x — upgrading from the previous major version