Skip to content

MultiSelect ​

MultiSelect プロンプトはチェックボックスを使ってリストから複数の項目を選択させます。

基本的な使い方 ​

csharp
var cities = Prompt.MultiSelect("Which cities would you like to visit?",
    new[] { "Seattle", "London", "Tokyo", "New York", "Singapore", "Shanghai" },
    pageSize: 3);
Console.WriteLine($"You picked {string.Join(", ", cities)}");

パラメータ ​

パラメータ型説明
messagestringユーザーに表示するメッセージ
itemsIEnumerable<T>?選択肢の項目 (Enum 型の場合は自動生成)
pageSizeint1 ページあたりの表示項目数 (デフォルト: 無制限)
minimumint選択必須の最小項目数 (デフォルト: 1)
maximumint選択可能な最大項目数 (デフォルト: 無制限)
defaultValuesIEnumerable<T>?デフォルトで選択される項目
textSelectorFunc<T, string>?項目を表示テキストに変換する関数

Options クラス ​

csharp
var cities = Prompt.MultiSelect(new MultiSelectOptions<string>
{
    Message = "Which cities would you like to visit?",
    Items = new[] { "Seattle", "London", "Tokyo", "New York", "Singapore", "Shanghai" },
    PageSize = 3,
    Minimum = 1,
    Maximum = 3,
    DefaultValues = new[] { "Tokyo" }
});

プロパティ ​

プロパティ型デフォルト説明
ItemsIEnumerable<T>—選択肢の項目
DefaultValuesIEnumerable<T>[]デフォルトで選択される項目
PageSizeintint.MaxValue1 ページあたりの項目数
Minimumint1選択必須の最小数
Maximumintint.MaxValue選択可能な最大数
TextSelectorFunc<T, string>x => x.ToString()!表示テキストセレクタ
LoopingSelectionbooltrue上下キーで現在のページ内を循環する(true)か、前後のページへ移動する(false)か。ページ移動では先頭ページと最終ページの間も循環する

選択のルール ​

  • Items はプロンプトの開始時に 1 回だけ読み取ります。等しい項目(EqualityComparer<T>.Default で比較)は、最初の位置に 1 つだけ表示します。
  • Items に含まれない DefaultValues は無視されます。
  • 結果には、選択された項目が Items の順序で含まれます。
  • Minimum と Maximum は選択数を制限します:
操作結果
選択数が Maximum のときに、未選択の項目で Space項目は選択されず、エラーを表示します。
Maximum を超える Ctrl+A または Ctrl+I何も変更せず、エラーを表示します。
Maximum より多い DefaultValuesすべて選択された状態で始まります。十分に選択を外すまで Enter は拒否されます。
Minimum 未満または Maximum 超過での Enterエラーを表示して拒否します。

Ctrl+A と Ctrl+I は、現在のフィルターに一致する項目だけに作用します。フィルターで隠れている選択済みの項目は、選択されたままです。

Minimum が負の値、Maximum が Minimum より小さい、または Minimum が項目数より大きい場合は、プロンプトに回答できないため、表示する前に ArgumentOutOfRangeException をスローします。Items が空の場合は Minimum を 0 にしてください。

Enum 型の使用 ​

csharp
var values = Prompt.MultiSelect<MyEnum>("Select enum values", defaultValues: new[] { MyEnum.Bar });
Console.WriteLine($"You picked {string.Join(", ", values)}");

項目は Select と同じ順序で並びます。項目の並び順 を参照してください。

Fluent API ​

csharp
using Sharprompt.Fluent;

var cities = Prompt.MultiSelect<string>(o => o.WithMessage("Which cities would you like to visit?")
                                               .WithItems(new[] { "Seattle", "London", "Tokyo" })
                                               .WithPageSize(3));

Released under the MIT License.