Skip to content

List

The List prompt lets the user add multiple items interactively.

Basic Usage

csharp
var value = Prompt.List<string>("Please add item(s)");
Console.WriteLine($"You picked {string.Join(", ", value)}");

Parameters

ParameterTypeDescription
messagestringThe message to display to the user
minimumintMinimum number of items required (default: 1)
maximumintMaximum number of items allowed (default: unlimited)
validatorsIList<Func<object?, ValidationResult?>>?List of validators for each item

Options Class

csharp
var value = Prompt.List(new ListOptions<string>
{
    Message = "Please add item(s)",
    Minimum = 1,
    Maximum = 5,
    Validators = { Validators.Required() }
});

Properties

PropertyTypeDefaultDescription
DefaultValuesIEnumerable<T>[]Items pre-populated in the list
Minimumint1Minimum number of items required
Maximumintint.MaxValueMaximum number of items allowed
ValidatorsIList<Func<object?, ValidationResult?>>[]Validators for each item

Fluent API

csharp
using Sharprompt.Fluent;

var value = Prompt.List<string>(o => o.WithMessage("Please add item(s)")
                                      .WithMinimum(1)
                                      .WithMaximum(5));

Released under the MIT License.