/LINQPadDialogs

A helper library that provides the ability to implement interactive user interfaces using LINQPad's built-in Controls.

Primary LanguageC#Apache License 2.0Apache-2.0

LINQPadDialogs

NuGet Version GitHub Sponsors

A helper library that provides the ability to implement interactive user interfaces using LINQPad's built-in Controls.

LINQPad 8 LINQPad 5
As used in LINQPad 8 As used in LINQPad 5

Please read before continuing

  • This NuGet package is supported by the generosity of community members. A small donation through GitHub Sponsorship will go a long way toward keeping the project running. (Donate Now)
  • This library is intended to be used with LINQPad. It is not recommended for use in production development code.
  • This package also requires a license of at least the Developer Edition of LINQPad to use it.
  • If you write a script using the features provided by this package, it may not be possible to run it with the lprun CLI tool.

Features

I will be gradually developing and supplementing this library.

Interactivity Features (Button Array)

It provides a simple async/await method to display multiple buttons, and to see what button the user has selected in the console.

If needed, you can customize the ButtonArray types that are added to the LINQPad.Controls namespace.

Here is an example of the code:

using LINQPad.Controls;

switch (await Dialog.YesNo<string>("Are you happy now?", "yes", "no"))
{
	case "yes":
		"Answer: Yes".Dump();
		break;
	case "no":
		"Answer: No".Dump();
		break;
	default:
		"Answer: ?".Dump();
		break;
}

Interactivity Features (Prompt)

Draw a UI that allows you to type whatever you want into the text box. Unlike Console.In.ReadLine methods, this feature shows a text box and OK and Cancel buttons on the screen.

Here is an example of the code:

using LINQPad.Controls;

var answer = await OKCancelPrompt("What's your name?");

if (answer == default) $"You didn't enter a name.".Dump();
else $"Your name is: {answer}.".Dump();

You can use the Choose or Multiple Choice prompts here.

using LINQPad.Controls;

// Single Choice
var answer = await Dialog.SelectOneAnswerPrompt("What's your favorite fruit?", default, "Apple", "Banana", "Kiwi", "Peach", "Watermelon");
$"Your favorite food is: {answer}".Dump();

// Multiple Choices
var answers = await Dialog.SelectMultipleAnswersPrompt("What's your favorite foods?", default, "Bulgogi", "Kimbap", "Ramen", "Kimchi Jjigae");
$"Your favorite foods are: {string.Join(", ", answers)}".Dump();

The ability to enter a password is also available.

using LINQPad.Controls;

var password = await Dialog.PasswordPrompt("Enter your password");
var encodedPassword = await Dialog.PasswordPromptAsBytes("Enter your password again", new UTF8Encoding(false));

License

This project is licensed under the Apache License 2.0.