SelectionPrompt<TKey, TValue> for returning different values than what is displayed

[Atulin]

Example usage:

var amount = AnsiConsole.Prompt(
    new SelectionPrompt<int, string>()
        .Title("How many things?")
        .AddChoices([
            new Selection(0, "None for me"),
            new(1, "Just one"),
            new(2, "A couple"),
            new(10, "Plenty"),
            new(100, "I want [bold]a lot[/] of them!")
        ]));

As it is right now, the best option seems to be

var options = new Dictionary<string, int>() {
    ["None for me"] = 0,
    ["Just one"] = 1,
    ["A couple"] = 2,
    ["Plenty"] = 10,
    ["I want a lot of them!"] = 100,
};

var key = AnsiConsole.Prompt(
    new SelectionPrompt<string>()
        .Title("How many things?")
        .AddChoices(options.Keys));

var amount = options[key];

Alternatively, instead of using a new object with a key and value, .AddChoices() could perhaps just take a dictionary

[nils-a]

I don't think such a feature is needed.
SelectionPrompt<T> already does support selecting arbitrary objects, you simply need to point the SelectionPrompt<T> to something stringy that can be written out as the option.

Solution 1: Use SelectionPrompt<T>.UseConverter()

using Spectre.Console;

var amount = AnsiConsole.Prompt(
    new SelectionPrompt<MySelection>()
        .Title("How many things?")
        .UseConverter(x => x.Name)
        .AddChoices([
            new (0, "None for me"),
            new(1, "Just one"),
            new(2, "A couple"),
            new(10, "Plenty"),
            new(100, "I want [bold]a lot[/] of them!")
        ]));

AnsiConsole.WriteLine($"You selected {amount.Count} items.");

internal record MySelection
{
    internal MySelection(int count, string name)
    {
        Count = count;
        Name = name;
    }
    
    internal int Count { get; }
    internal string Name { get; }
}

Solution 2: Use a TypeConverter

using System.ComponentModel;
using System.Globalization;
using Spectre.Console;

var amount = AnsiConsole.Prompt(
    new SelectionPrompt<MySelection>()
        .Title("How many things?")
        .AddChoices([
            new (0, "None for me"),
            new(1, "Just one"),
            new(2, "A couple"),
            new(10, "Plenty"),
            new(100, "I want [bold]a lot[/] of them!")
        ]));

AnsiConsole.WriteLine($"You selected {amount.Count} items.");

[TypeConverter(typeof(MySelectionConverter))]
internal record MySelection
{
    internal MySelection(int count, string name)
    {
        Count = count;
        Name = name;
    }
    
    internal int Count { get; }
    internal string Name { get; }
}

public class MySelectionConverter: TypeConverter
{
    public override object? ConvertTo(ITypeDescriptorContext? context, CultureInfo? culture, object? value, Type destinationType)
    {
        if (destinationType == typeof(string))
        {
            return ((MySelection)value).Name;
        }
        return base.ConvertTo(context, culture, value, destinationType);
    }
}

Solution 3: Implement ToString()

using Spectre.Console;

var amount = AnsiConsole.Prompt(
    new SelectionPrompt<MySelection>()
        .Title("How many things?")
        .AddChoices([
            new (0, "None for me"),
            new(1, "Just one"),
            new(2, "A couple"),
            new(10, "Plenty"),
            new(100, "I want [bold]a lot[/] of them!")
        ]));

AnsiConsole.WriteLine($"You selected {amount.Count} items.");

internal record MySelection
{
    internal MySelection(int count, string name)
    {
        Count = count;
        Name = name;
    }
    
    internal int Count { get; }
    internal string Name { get; }

    public override string ToString()
    {
        return Name;
    }
}