tk/spectre.console
1
0
Fork 0
mirror of https://github.com/nsnail/spectre.console.git synced 2025-04-16 00:42:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add support for selection prompt highlighting

Browse Source
This commit is contained in:
Nick 2021-01-15 14:23:09 +00:00 committed by GitHub
parent 1a747696a8
commit 63bae278a9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 52 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/Spectre.Console/Widgets/Prompt/MultiSelectionPrompt.cs
View File

@ -35,6 +35,11 @@ namespace Spectre.Console
/// </summary>
public int PageSize { get; set; } = 10;
/// <summary>
/// Gets or sets the highlight style of the selected choice.
/// </summary>
public Style? HighlightStyle { get; set; }
/// <summary>
/// Gets or sets a value indicating whether or not
/// at least one selection is required.
@ -68,7 +73,7 @@ namespace Spectre.Console
var converter = Converter ?? TypeConverterHelper.ConvertToString;
var list = new RenderableMultiSelectionList<T>(console, Title, PageSize, Choices, converter);
var list = new RenderableMultiSelectionList<T>(console, Title, PageSize, Choices, converter, HighlightStyle);
using (new RenderHookScope(console, list))
{
console.Cursor.Hide();

18
src/Spectre.Console/Widgets/Prompt/MultiSelectionPromptExtensions.cs
View File

@ -103,6 +103,24 @@ namespace Spectre.Console
return obj;
}
/// <summary>
/// Sets the highlight style of the selected choice.
/// </summary>
/// <typeparam name="T">The prompt result type.</typeparam>
/// <param name="obj">The prompt.</param>
/// <param name="highlightStyle">The highlight style of the selected choice.</param>
/// <returns>The same instance so that multiple calls can be chained.</returns>
public static MultiSelectionPrompt<T> HighlightStyle<T>(this MultiSelectionPrompt<T> obj, Style highlightStyle)
{
if (obj is null)
{
throw new ArgumentNullException(nameof(obj));
}
obj.HighlightStyle = highlightStyle;
return obj;
}
/// <summary>
/// Requires no choice to be selected.
/// </summary>

4
src/Spectre.Console/Widgets/Prompt/Rendering/RenderableMultiSelectionList.cs
View File

@ -17,12 +17,12 @@ namespace Spectre.Console
public RenderableMultiSelectionList(
IAnsiConsole console, string? title, int pageSize,
List<T> choices, Func<T, string>? converter)
List<T> choices, Func<T, string>? converter, Style? highlightStyle)
: base(console, pageSize, choices, converter)
{
_console = console ?? throw new ArgumentNullException(nameof(console));
_title = title;
_highlightStyle = new Style(foreground: Color.Blue);
_highlightStyle = highlightStyle ?? new Style(foreground: Color.Blue);
Selections = new HashSet<int>();
}

4
src/Spectre.Console/Widgets/Prompt/Rendering/RenderableSelectionList.cs
View File

@ -12,12 +12,12 @@ namespace Spectre.Console
private readonly string? _title;
private readonly Style _highlightStyle;
public RenderableSelectionList(IAnsiConsole console, string? title, int requestedPageSize, List<T> choices, Func<T, string>? converter)
public RenderableSelectionList(IAnsiConsole console, string? title, int requestedPageSize, List<T> choices, Func<T, string>? converter, Style? highlightStyle)
: base(console, requestedPageSize, choices, converter)
{
_console = console ?? throw new ArgumentNullException(nameof(console));
_title = title;
_highlightStyle = new Style(foreground: Color.Blue);
_highlightStyle = highlightStyle ?? new Style(foreground: Color.Blue);
}
protected override int CalculatePageSize(int requestedPageSize)

7
src/Spectre.Console/Widgets/Prompt/SelectionPrompt.cs
View File

@ -34,6 +34,11 @@ namespace Spectre.Console
/// </summary>
public int PageSize { get; set; } = 10;
/// <summary>
/// Gets or sets the highlight style of the selected choice.
/// </summary>
public Style? HighlightStyle { get; set; }
/// <summary>
/// Initializes a new instance of the <see cref="SelectionPrompt{T}"/> class.
/// </summary>
@ -61,7 +66,7 @@ namespace Spectre.Console
var converter = Converter ?? TypeConverterHelper.ConvertToString;
var list = new RenderableSelectionList<T>(console, Title, PageSize, Choices, converter);
var list = new RenderableSelectionList<T>(console, Title, PageSize, Choices, converter, HighlightStyle);
using (new RenderHookScope(console, list))
{
console.Cursor.Hide();

18
src/Spectre.Console/Widgets/Prompt/SelectionPromptExtensions.cs
View File

@ -103,6 +103,24 @@ namespace Spectre.Console
return obj;
}
/// <summary>
/// Sets the highlight style of the selected choice.
/// </summary>
/// <typeparam name="T">The prompt result type.</typeparam>
/// <param name="obj">The prompt.</param>
/// <param name="highlightStyle">The highlight style of the selected choice.</param>
/// <returns>The same instance so that multiple calls can be chained.</returns>
public static SelectionPrompt<T> HighlightStyle<T>(this SelectionPrompt<T> obj, Style highlightStyle)
{
if (obj is null)
{
throw new ArgumentNullException(nameof(obj));
}
obj.HighlightStyle = highlightStyle;
return obj;
}
/// <summary>
/// Sets the function to create a display string for a given choice.
/// </summary>