BlyZe.BetterReadLine 1.1.0

.NET 6.0
NuGet\Install-Package BlyZe.BetterReadLine -Version 1.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
dotnet add package BlyZe.BetterReadLine --version 1.1.0
<PackageReference Include="BlyZe.BetterReadLine" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add BlyZe.BetterReadLine --version 1.1.0
#r "nuget: BlyZe.BetterReadLine, 1.1.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install BlyZe.BetterReadLine as a Cake Addin
#addin nuget:?package=BlyZe.BetterReadLine&version=1.1.0

// Install BlyZe.BetterReadLine as a Cake Tool
#tool nuget:?package=BlyZe.BetterReadLine&version=1.1.0


An easy to use and highly customizable alternative for Console.ReadLine();

How to use

Initialize a new ConsoleInputReader instance

var inputReader = new ConsoleInputReader(true, new InputReaderColor(255, 100, 69), ConsoleKey.Enter, true, 1, 20);

Then use it like Console.ReadLine();

string text = inputReader.Read("abc123"); //This enables the user to input 'a', 'b', 'c', '1', '2', '3' but nothing else

The user should input a password? Here:

string text = inputReader.ReadAsPassword("abc123", '*'); //Does exactly the same as the method above but replaces every char with the '*'

You can also use Regex for input restriction

string text = inputReader.ReadWithRegex("[a-z]", System.Text.RegularExpressions.RegexOptions.IgnoreCase); //This enables the user to input every letter of the alphabet and ignores the case

Need to use Regex in combination with password? Here:

string text = inputReader.ReadWithRegexAsPassword("[a-z]", '?'); Does the same as the method above but it only accepts lowercase letters and replaces every char with the '?'

You can get information about the ConsoleInputReader instance

bool showInput = inputReader.BackspaceEnabled;
InputReaderColor inputColor = inputReader.InputColor;
ConsoleKey enterKey = inputReader.EnterKey;
bool backspaceEnabled = inputReader.BackspaceEnabled;
int minInputLength = inputReader.MinInputLength;
int maxInputLength = inputReader.MaxInputLength;
Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.0 32 9/29/2022
1.0.0 56 8/3/2022

Added Generics for ConsoleInputReader.Read(...);