Welcome to PromptPlus

Interactive command-line toolkit for .NET Core with powerful controls and commands to create professional console applications.

PromptPlus was developed in C# with the netstandard2.1, .NET 6 , .NET 7 and .NET 8 target frameworks.

Visit the official page for more documentation of PromptPlus

What's new - previous versions
Features
Migrate Version V3.3 to V4.0
Console Engine
Installing
Examples
Controls Snapshot
Usage
Culture
Colors
Hotkeys
Keypress Extensions Emacs
Validators
Supported Platforms
Code of Conduct
Contributing
Credits
License
API Reference

What's new in the latest version

V4.2.0

Top

Added .NET8 target frameworks.
Split of feature:
- PromptPlus.TableSelect<T> to Select item in table : Select row, column and data in a grid/table
  - Samples in project Table Select Samples
- PromptPlus.Table<T> to write table in console : Show data in a grid/table
  - Samples in project Table Samples
New Control : TableMultSelect<T> : Select multi-data in a grid/table
- Samples in project Table MultiSelect Samples
- Main features :
  - More than 80 layout combinations
  - Navigation by row and columns
  - Scroll the table when it is larger than the screen
  - Split text when it is larger than the column size
  - Automatic header and column completion
  - Color customization of each element
  - Search for data filtered by columns
  - Formatting by column or by data type definition
New feature:
- MinimalRender the prompt and control description are not rendered, showing only the minimum necessary without using resources.
  - Global property : MinimalRender
  - Instance control(By config command): MinimalRender(bool value = true)
New feature:
- Pagination Template to customize pagination information
  - Global property : PaginationTemplate
  - Instance control(By config command) : PaginationTemplate(Func<int, int, int, string>? value)
New feature:
- PromptPlus.Join()
- Fluent-Interface to write text (less code typed)
Changed feature:
- Moved tooltips and validation message to the end of render to all control
Improvement :
- Color Token now accepts ':' to separate foreground color from background color
- eg: [RED:BLUE] = [RED ON BLUE]
Improvement :
- Optimized the Calendar control to have symbols when selecting elements
Improvement :
- Optimize Render of ProgressBar (less lines)
Improvement :
- Optimize Render of SliderNumber (less lines)
Improvement :
- Added Styles command for custom colors on all controls
  - Removed the ApplyStyle command from the Config interface (now use the Styles command)
  - Added ToStyle() extension for Color Class (less code typed)
Improvement :
- Added command HideRange to not show range (Min/Max values) in the SliderNumber control
Improvement :
- Optimize resource usage in rendering (less cultural dependency)
Improvement :
- Reinforce the validation of invalid or optional parameters in all controls
Improvement :
- Remove code copy (MIT license) from other project and applied package (for lower maintenance)
Improvement :
- Optimized the WaitControl control (for cancel correctly tasks)
- Removed property Context (EventWaitProcess)
- Added Method ChangeContext(Action<T> action) in EventWaitProcess (for change context over thread safe)
- Renamed command 'CancelAllNextTasks' to 'CancelAllTasks' (WaitControl)
Documentation:
- Examples of snapshot controls updated to reflect layout changes and reduced image size (faster page loading)
- Reviewed credit references and licenses
Renamed command:
- 'DescriptionWithInputType' to 'ShowTipInputType'.
- Now extra-line to tip InputType
Renamed command:
- 'AppendGroupOnDescription' to 'ShowTipGroup'.
- Now extra-line to tip group
Fixed bug :
- Table control does not render correctly when it does not support Unicode
Fixed bug :
- The Slide Switch Control does not show on/off values when they are not customized
Fixed bug :
- Alternate screen doesn't update background style when changing color
Fixed bug :
- Exception when try delete[F3] in empty colletion in AddTolist/AddtoMaskEditList control
Fixed bug :
- Edit[F2] Immutable item in AddTolist/AddtoMaskEditList control
Fixed bug :
- CTRL-V (paste data) does not show input in some controls
Fixed bug :
- Refinement of Unicode symbol rendering in all controls (Corret render)
Removed Control Pipeline :
- Now use PipeAndFilter component
- See Pipeline Sample

Features

Top

All features have IntelliSense. PromptPlus has more than 25 controls with many features like: filters, validators, history, suggestions, spinner(19 embedding type and plus custom yours!), colors and styles for control-elements :

Banner Ascii
Input text / Secret / AutoComplete with spinner
MaskEdit Generic / Only Date / Only Time / DateTime / Number / Currency
Calendar with multiple layouts
Select and Multi-Select(with group select!)
AddTo(Add/Remove) items for text and masked text
Wait Keypress with animate spinner
Slider numeric ranger with gradient colors
Up-Down numeric ranger
Switch (style on/off)
Wait Process (Run background tasks Sequential/Parallel) with elapsedtime and spinner
Wait Time with countdown and spinner
ChartBar with enabled Interaction to switch layout, Legend and order when browse the charts / Legends.
Progress bar with 8 types , gradient colors and spinner
Browser File and Folder with multi-select, colors and spinner
Treeview hierarchical structures with multi-select and colors
Switch Alternate screen
Execution pipeline with conditions
Table, TableSelect and TableMultSelct with multiple layouts

All controls have the same organization (see in action: Controls Snapshot):

input/filter (except Masked input) using GNU Readline Emacs keyboard shortcuts.
Prompt, description and data entry (ever)
Extra actions per stage: OnStartControl/OnInputRender/OnTryAcceptInput/OnFinishControl (ever)
Tooltips (ever and configurable)
Filter by Contains / StartsWith (configurable) (depends on the control)
Collection subset items and iterations (depends on the control)
Page information and page-size(depends on the control)
Spinner animation (depends on the control)
Error message (depends on the control and validators)

PromptPlus driver console Supports 4/8/24-bit colors in the terminal with auto-detection of the current terminal's capabilities.

Migrate Version

Top

Until version 3 the console engine was based on a model from another project. PromptPlus v4 has been completely rebuilt for a better experience, with significant improvements with new controls and more developer power. The console driver now supports better rendering, with the ability to detect terminal capabilities and allow for 24-bit color, text overflow strategies based on terminal size, and left and right margins for a nicer layout. The Controls have been revised to be more responsive, allow color styles in many of their elements, and adapt to the terminal size even with resizing.

For migrate V3.3 to V4.0 see this link.

Console Engine

Top

The console driver has the ability to detect terminal capabilities and allow for 24-bit color and text overflow strategies based on terminal size, and left and right margins for a nicer layout and automatic color conversion. The new engine detects support ansi commands and adjust output for this functionality respecting OS differences , terminal mode and Windows console mode. The Colors are automatically adjusted to the capacity of the terminal. This automatic adjustment may slightly modify the final color when converting to a lower bit resolution.

Sample Output detect (ConsoleFeaturesSamples)

Sample Output Overflow Capacity (ConsoleFeaturesSamples)

Sample color capacity (ConsoleFeaturesSamples)

Note: This layout and code were based (code copy and adaptation) on the excellent project: spectrum console, having the same color palette

Installing

Top

Install-Package PromptPlus [-pre]

dotnet add package PromptPlus [--prerelease]

Note: [-pre]/[--prerelease] usage for pre-release versions

Examples

Top

The folder Samples contains more 40 samples!.

dotnet run --project [name of sample]

Controls Snapshot

AddToList

Top | Samples

AlternateScreen

Top | Samples

AutoComplete

Top | Samples

Banner

Top | Samples

Browser

Top | Samples

Calendar

Top | Samples

ChartBar

Top | Samples

Confirm

Top | Samples

Console Features

Top | Samples

Input

Top | Samples

KeyPress

Top | Samples

MaskEdit

Top | Samples

MultSelect

Top | Samples

ProgressBar

Top | Samples

Select

Top | Samples

SliderNumber

Top | Samples

SliderSwitch

Top | Samples

Table

Top | Samples

TreeView

Top | Samples

Wait Tasks

Top | Samples

Wait Timer

Top | Samples

Usage

Top

All controls use fluent interface; an object-oriented API whose design relies extensively on method chaining. Its goal is to increase code legibility. The term was coined in 2005 by Eric Evans and Martin Fowler.

//MaskEdit Generic
var mask = PromptPlus.MaskEdit("input", "MaskEdit Generic input")
    .Mask(@"\XYZ 9{3}-L{3}-C[ABC]N{1}[XYZ]-A{3}")
    .ShowTipInputType(FormatWeek.Short)
    .Run();

if (!mask.IsAborted)
{
    PromptPlus.WriteLine($"You input with mask is {mask.Value.Masked}");
    PromptPlus.WriteLine($"You input without mask is {mask.Value.Input}");
}

//AnyKey
var kp1 = PromptPlus
    .KeyPress()
    .Run();

if (!kp1.IsAborted)
{
    PromptPlus.WriteLine($"You Pressed {kp1.Value.Key}");
}

//input
var in1 = PromptPlus
    .Input("Input sample1")
    .Run();

if (!in1.IsAborted)
{
    PromptPlus.WriteLine($"You input is {in1.Value}");
}

Culture

Top

PromptPlus applies the language/culture only when running controls. The language/culture of the application is not affected. If language/culture is not informed, the application's language/culture will be used with fallback to en-US.

All messages are affected when changed language/culture. PromptPlus has languages embedded:

en-US (Default)
pt-BR

To use a non-embedded language/culture:

Copy the PromptPlusResources.resx file in folder PromptPlus/Resources
Translate messages with same format to your language/culture
Convert .resx files to binary .resources files (reference link here)
Publish the compiled file (PromptPlus.[Language].resources) in the same folder as the binaries.

Colors

Top

PromptPlus is in accordance with informal standard NO COLOR. when there is the environment variable "no_color" the colors are disabled.

Prompt Plus also has commands for coloring parts of the text.

Direct console

PromptPlus.WriteLine("[RGB(255,0,0) ON WHITE]Test[YELLOW] COLOR [/] BACK COLOR [/] other text");
PromptPlus.WriteLine("[RGB(255,0,0):WHITE]Test[YELLOW] COLOR [/] BACK COLOR [/] other text");
PromptPlus.WriteLine("[#ff0000 ON WHITE]Test [YELLOW] COLOR [/] BACK COLOR [/] other text");
PromptPlus.WriteLine("[RED ON WHITE]Test[YELLOW] COLOR [/] BACK COLOR [/] other text");
PromptPlus.WriteLine("[RED:WHITE]Test[YELLOW] COLOR [/] BACK COLOR [/] other text");

Using Style

PromptPlus.WriteLine("Test", new Style(Color.White, Color.Red, Overflow.None));
PromptPlus.WriteLine("Test", new Style(new Color(255, 255, 255), Color.Red, Overflow.None));
PromptPlus.WriteLine("Test", new Style(Color.FromConsoleColor(ConsoleColor.White), Color.Red, Overflow.None));
PromptPlus.WriteLine("Test", new Style(Color.FromInt32(255), Color.Red, Overflow.None));

Over controls

PromptPlus
    .Input("Input [blue]sample2[/]", "with [yellow]description[/]")
    .Run();

Escaping format characters

To output a [ you use [[, and to output a ] you use ]].

PromptPlus.WriteLine("[[Test]]");

using (PromptPlus.EscapeColorTokens())
{
   PromptPlus.DoubleDash($"PromptPlus with context IgnoreColorTokens = true");
   //show text without color
   PromptPlus.WriteLine("ValidformedColor_TokenAny[RED ON WHITE]Text[/]_[YELLOW]Othertext[/]");
}

Promptplus uses the same default colors and engine(softly modified) as the third party project: spectreconsole. For more details visit the official page or see the samples in folder Samples/ConsoleFeaturesSamples

Hotkeys

Top

Hotkeys (global and control-specific) are configurable. Some hotkeys are internal and reserved. For more details visit the official page

Keypress Extensions Emacs

Top

PromptPlus have a lot extensions to check Key-press with GNU Readline Emacs keyboard shortcuts. For more details visit the official page

Validators

PromptPlus have a lot extensions to commons validator and validator import(No duplicate code!) For more details visit the official page or see the samples in folder Samples

private class MylCass
{
    [Required(ErrorMessage = "{0} is required!")]
    [MinLength(3, ErrorMessage = "Min. Length = 3.")]
    [MaxLength(5, ErrorMessage = "Max. Length = 5.")]
    [Display(Prompt ="My Input")]
    public string MyInput { get; set; }
}

var inst = new MylCass();

PromptPlus
    .Input("Input sample2", "import validator from decorate")
    .Default(inst.Text)
    .AddValidators(PromptValidators.ImportValidators(inst,x => x!.Text!))
    .Run();

if (name.IsAborted)
{
   return;
}
PromptPlus.WriteLine($"Your input: {name.Value}!");

Supported platforms

Top

Windows
- Command Prompt, PowerShell, Windows Terminal
Linux (Ubuntu, etc)
- Windows Terminal (WSL 2)
macOS
- Terminal.app

Code of Conduct

Top

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the Code of Conduct.

Contributing

See the Contributing guide for developer documentation.

Credits

Top

PromptPlus includes code(Copy) from other software released under the MIT license:

Spectre.Console, Copyright (c) 2020 Patrik Svensson, Phil Scott, Nils Andresen. See LICENSE.

EastAsian width generated by package

API documentation generated by

License

Top

PromptPlus is licensed under the MIT license. See LICENSE.

PromptPlus PromptPlus copied to clipboard

Metadata

Welcome to PromptPlus

Table of Contents

What's new in the latest version

V4.2.0

Features

Migrate Version

Console Engine

Sample Output detect (ConsoleFeaturesSamples)

Sample Output Overflow Capacity (ConsoleFeaturesSamples)

Sample color capacity (ConsoleFeaturesSamples)

Installing

Examples

Controls Snapshot

AddToList

AlternateScreen

AutoComplete

Banner

Browser

Calendar

ChartBar

Confirm

Console Features

Input

KeyPress

MaskEdit

MultSelect

ProgressBar

Select

SliderNumber

SliderSwitch

Table

TreeView

Wait Tasks

Wait Timer

Usage

Culture

Colors

Direct console

Using Style

Over controls

Escaping format characters

Hotkeys

Keypress Extensions Emacs

Validators

Supported platforms

Code of Conduct

Contributing

Credits

License

← Metadata

Owner

Metadata

PromptPlus
PromptPlus copied to clipboard