MenuConsoleBuilder 1.0.1

MenuConsoleBuilder

MenuConsoleBuilder is a .NET 6 library for building console-based menus with customizable options and actions. It provides a simple API for creating console menus with options that the user can select by typing a key. The library includes features such as prompting the user for input, clearing the console after an option has been selected, and displaying all the available options.

Installation

MenuConsoleBuilder can be installed via NuGet Package Manager:

Install-Package MenuConsoleBuilder

Usage

To use MenuConsoleBuilder, you first need to create a ConsoleMenuReadBuilder object for each value you want to read from the user. This object defines the options that the user can select and the actions that are performed when an option is selected. Once you have read all the values you need, you can create a ConsoleMenuBuilder object to create a menu with options that execute different actions based on the values that were previously read.

Examples

1. Simple value picker

// Create a menu to pick a value between 1 and 3
var valuePicker = new ConsoleMenuReadBuilder<int>()
    .AddOption("1", () => 1)
    .AddOption("2", () => 2)
    .AddOption("3", () => 3)
    .SetPrompt("Please enter a number between 1 and 3: ");

// Read the user's input and store the result
int value = valuePicker.ReadInput();

// Do something with the value (e.g. print it to the console)
Console.WriteLine($"You picked {value}.");

• Basic menu with options

// Create a menu with three options
new ConsoleMenuBuilder()
    .AddOption("1", "Say hello", () => Console.WriteLine("Hello!"))
    .AddOption("2", "Say goodbye", () => Console.WriteLine("Goodbye!"))
    .AddOption("3", "Do nothing", () => {})
    .SetFirstPrompt("What would you like to do?")
    .Build();

• Looping menu

// Create a menu with a looping prompt
new ConsoleMenuBuilder()
    .AddOption("1", "Say hello", () => Console.WriteLine("Hello!"))
    .AddOption("2", "Say goodbye", () => Console.WriteLine("Goodbye!"))
    .SetFirstPrompt("What would you like to do?")
    .AsLoop()
    .Build();

• Yes/No menu

// Create a yes/no menu
new ConsoleMenuBuilder()
    .SetFirstPrompt("Would you like to continue?")
    .CreateSimpleYesNoMenu(
        () => Console.WriteLine("You picked 'yes'."),
        () => Console.WriteLine("You picked 'no'.")
    )
    .Build();

ConsoleMenuBuilder methods

ConsoleMenuReadBuilder<T> methods