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

Add convenience methods for tree nodes

Browse Source
This commit is contained in:
Patrik Svensson
2021-01-02 15:54:54 +01:00
committed by Patrik Svensson
parent 87e6b42409
commit 1f211d3e1f
2 changed files with 119 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

122
src/Spectre.Console/Extensions/HasTreeNodeExtensions.cs
View File

@@ -1,4 +1,5 @@
using System;
using System.Linq;
using Spectre.Console.Rendering;
namespace Spectre.Console
@@ -9,7 +10,49 @@ namespace Spectre.Console
public static class HasTreeNodeExtensions
{
/// <summary>
/// Adds a child tree node.
/// Adds a tree node.
/// </summary>
/// <typeparam name="T">An object type with tree nodes.</typeparam>
/// <param name="obj">The object that has tree nodes.</param>
/// <param name="markup">The node's markup text.</param>
/// <returns>The same instance so that multiple calls can be chained.</returns>
public static T AddNode<T>(this T obj, string markup)
where T : class, IHasTreeNodes
{
if (obj is null)
{
throw new ArgumentNullException(nameof(obj));
}
if (markup is null)
{
throw new ArgumentNullException(nameof(markup));
}
return AddNode(obj, new Markup(markup));
}
/// <summary>
/// Adds a tree node.
/// </summary>
/// <typeparam name="T">An object type with tree nodes.</typeparam>
/// <param name="obj">The object that has tree nodes.</param>
/// <param name="markup">The node's markup text.</param>
/// <param name="action">An action that can be used to configure the created node further.</param>
/// <returns>The same instance so that multiple calls can be chained.</returns>
public static T AddNode<T>(this T obj, string markup, Action<TreeNode> action)
where T : class, IHasTreeNodes
{
if (markup is null)
{
throw new ArgumentNullException(nameof(markup));
}
return AddNode(obj, new Markup(markup), action);
}
/// <summary>
/// Adds a tree node.
/// </summary>
/// <typeparam name="T">An object type with tree nodes.</typeparam>
/// <param name="obj">The object that has tree nodes.</param>
@@ -23,19 +66,24 @@ namespace Spectre.Console
throw new ArgumentNullException(nameof(obj));
}
if (renderable is null)
{
throw new ArgumentNullException(nameof(renderable));
}
obj.Children.Add(new TreeNode(renderable));
return obj;
}
/// <summary>
/// Adds a child tree node.
/// Adds a tree node.
/// </summary>
/// <typeparam name="T">An object type with tree nodes.</typeparam>
/// <param name="obj">The object that has tree nodes.</param>
/// <param name="renderable">The renderable to add.</param>
/// <param name="config">An action that can be used to configure the created node further.</param>
/// <param name="action">An action that can be used to configure the created node further.</param>
/// <returns>The same instance so that multiple calls can be chained.</returns>
public static T AddNode<T>(this T obj, IRenderable renderable, Action<TreeNode> config)
public static T AddNode<T>(this T obj, IRenderable renderable, Action<TreeNode> action)
where T : class, IHasTreeNodes
{
if (obj is null)
@@ -43,20 +91,25 @@ namespace Spectre.Console
throw new ArgumentNullException(nameof(obj));
}
if (config is null)
if (renderable is null)
{
throw new ArgumentNullException(nameof(config));
throw new ArgumentNullException(nameof(renderable));
}
if (action is null)
{
throw new ArgumentNullException(nameof(action));
}
var node = new TreeNode(renderable);
config(node);
action(node);
obj.Children.Add(node);
return obj;
}
/// <summary>
/// Adds a child tree node.
/// Adds a tree node.
/// </summary>
/// <typeparam name="T">An object type with tree nodes.</typeparam>
/// <param name="obj">The object that has tree nodes.</param>
@@ -70,8 +123,61 @@ namespace Spectre.Console
throw new ArgumentNullException(nameof(obj));
}
if (node is null)
{
throw new ArgumentNullException(nameof(node));
}
obj.Children.Add(node);
return obj;
}
/// <summary>
/// Add multiple tree nodes.
/// </summary>
/// <typeparam name="T">An object type with tree nodes.</typeparam>
/// <param name="obj">The object that has tree nodes.</param>
/// <param name="nodes">The tree nodes to add.</param>
/// <returns>The same instance so that multiple calls can be chained.</returns>
public static T AddNodes<T>(this T obj, params string[] nodes)
where T : class, IHasTreeNodes
{
if (obj is null)
{
throw new ArgumentNullException(nameof(obj));
}
if (nodes is null)
{
throw new ArgumentNullException(nameof(nodes));
}
obj.Children.AddRange(nodes.Select(node => new TreeNode(new Markup(node))));
return obj;
}
/// <summary>
/// Add multiple tree nodes.
/// </summary>
/// <typeparam name="T">An object type with tree nodes.</typeparam>
/// <param name="obj">The object that has tree nodes.</param>
/// <param name="nodes">The tree nodes to add.</param>
/// <returns>The same instance so that multiple calls can be chained.</returns>
public static T AddNodes<T>(this T obj, params TreeNode[] nodes)
where T : class, IHasTreeNodes
{
if (obj is null)
{
throw new ArgumentNullException(nameof(obj));
}
if (nodes is null)
{
throw new ArgumentNullException(nameof(nodes));
}
obj.Children.AddRange(nodes);
return obj;
}
}
}