English
Configuration
Sharprompt allows you to customize the appearance and behavior of prompts globally.
Symbols
You can customize the symbols used by prompts:
csharp
Prompt.Symbols.Prompt = new Symbol("🤔", "?");
Prompt.Symbols.Done = new Symbol("😎", "V");
Prompt.Symbols.Error = new Symbol("😱", ">>");
var name = Prompt.Input<string>("What's your name?");The Symbol class takes two arguments: a Unicode value and a fallback value for terminals that don't support Unicode.
Available Symbols
| Symbol | Default (Unicode) | Default (Fallback) | Description |
|---|---|---|---|
Prompt | ? | ? | Displayed before the prompt message |
Done | ✔ | V | Displayed when the prompt is completed |
Error | » | >> | Displayed when validation fails |
Selector | › | > | Points to the currently highlighted item |
Selected | ◉ | (*) | Marks a selected item in MultiSelect |
NotSelect | ◯ | ( ) | Marks an unselected item in MultiSelect |
Color Schema
Customize the colors used by prompts:
csharp
Prompt.ColorSchema.Answer = ConsoleColor.DarkRed;
Prompt.ColorSchema.Select = ConsoleColor.DarkCyan;
var name = Prompt.Input<string>("What's your name?");Available Colors
| Property | Default | Description |
|---|---|---|
DoneSymbol | Green | Color of the done symbol |
PromptSymbol | Green | Color of the prompt symbol |
Answer | Cyan | Color of the user's answer |
Select | Green | Color of the selected item |
Error | Red | Color of error messages |
Hint | DarkGray | Color of hints and placeholders |
DisabledOption | DarkCyan | Color of disabled options |
Cancellation Support
By default, pressing Ctrl+C or Esc exits the process. You can change this behavior to throw an exception:
csharp
Prompt.ThrowExceptionOnCancel = true;
try
{
var name = Prompt.Input<string>("What's your name?");
Console.WriteLine($"Hello, {name}!");
}
catch (PromptCanceledException ex)
{
Console.WriteLine("Prompt canceled");
}Canceling from code
Every prompt accepts a CancellationToken through the overloads that take an options object or a configure delegate, and Prompt.Bind accepts one too. When the token is canceled while the prompt is waiting for input, the prompt is closed and an OperationCanceledException is thrown, regardless of ThrowExceptionOnCancel.
csharp
using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(30));
try
{
var name = Prompt.Input<string>(options => options.Message = "What's your name?", cts.Token);
Console.WriteLine($"Hello, {name}!");
}
catch (OperationCanceledException)
{
Console.WriteLine("Timed out");
}If the token is already canceled when the prompt is called, OperationCanceledException is thrown before the console driver is created.
For custom console driver authors: prompts wait for keys through IConsoleDriver.ReadKey(CancellationToken). Its default implementation polls KeyAvailable while the token can be canceled, so your driver must report KeyAvailable accurately. If your input source supports cancellation natively, or cannot report KeyAvailable, override ReadKey(CancellationToken) and throw OperationCanceledException for the given token when it is canceled.
Culture
Set the culture for localized messages:
csharp
Prompt.Culture = new CultureInfo("ja");Console Driver
You can provide a custom console driver factory:
csharp
Prompt.ConsoleDriverFactory = () => new MyCustomConsoleDriver();