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

Add tree example

Browse Source
This commit is contained in:
Patrik Svensson
2021-01-02 12:00:18 +01:00
committed by Patrik Svensson
parent 1aa958ced3
commit 87e6b42409
10 changed files with 150 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
examples/Console/Trees/Program.cs Normal file
View File

@@ -0,0 +1,47 @@
using Spectre.Console;
namespace TableExample
{
public static class Program
{
public static void Main()
{
var tree = new Tree();
tree.AddNode(new FigletText("Dec 2020"));
tree.AddNode(new Markup("[link]Click to go to summary[/]"));
// Add the calendar nodes
tree.AddNode(new Markup("[blue]Calendar[/]"),
node => node.AddNode(
new Calendar(2020, 12)
.AddCalendarEvent(2020, 12, 12)
.HideHeader()));
// Add video games node
tree.AddNode(new Markup("[red]Played video games[/]"),
node => node.AddNode(
new Table()
.RoundedBorder()
.AddColumn("Title")
.AddColumn("Console")
.AddRow("The Witcher 3", "XBox One X")
.AddRow("Cyberpunk 2077", "PC")
.AddRow("Animal Crossing", "Nintendo Switch")));
// Add the fruit nodes
tree.AddNode(new Markup("[green]Fruits[/]"), fruits =>
fruits.AddNode(new Markup("Eaten"),
node => node.AddNode(
new BarChart().Width(40)
.AddItem("Apple", 12, Color.Red)
.AddItem("Kiwi", 3, Color.Green)
.AddItem("Banana", 21, Color.Yellow))));
AnsiConsole.WriteLine();
AnsiConsole.MarkupLine("[yellow]Monthly summary[/]");
AnsiConsole.Render(tree);
}
}
}

15
examples/Console/Trees/Trees.csproj Normal file
View File

@@ -0,0 +1,15 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net5.0</TargetFramework>
<ExampleTitle>Trees</ExampleTitle>
<ExampleDescription>Demonstrates how to render trees in a console.</ExampleDescription>
<ExampleGroup>Widgets</ExampleGroup>
</PropertyGroup>
<ItemGroup>
<ProjectReference Include="..\..\..\src\Spectre.Console\Spectre.Console.csproj" />
</ItemGroup>
</Project>

22
src/Spectre.Console.Tests/Unit/TreeTests.cs
View File

@@ -20,15 +20,15 @@ namespace Spectre.Console.Tests.Unit
.Select(x => new TreeNode(new Text($"multiple \n line {x}")));
var child2 = new TreeNode(new Text("child2"));
var child2Child = new TreeNode(new Text("child2Child"));
child2.AddChild(child2Child);
child2Child.AddChild(new TreeNode(new Text("Child 2 child\n child")));
child2.AddNode(child2Child);
child2Child.AddNode(new TreeNode(new Text("Child 2 child\n child")));
var child3 = new TreeNode(new Text("child3"));
var child3Child = new TreeNode(new Text("single leaf\n multiline"));
child3Child.AddChild(new TreeNode(new Calendar(2020, 01)));
child3.AddChild(child3Child);
child3Child.AddNode(new TreeNode(new Calendar(2020, 01)));
child3.AddNode(child3Child);
var children = new List<TreeNode> { new(new Text("child1"), nestedChildren), child2, child3 };
var root = new TreeNode(new Text("Root node"), children);
var tree = new Tree().AddChild(root);
var tree = new Tree().AddNode(root);
// When
console.Render(tree);
@@ -47,15 +47,15 @@ namespace Spectre.Console.Tests.Unit
.Select(x => new TreeNode(new Text($"multiple \n line {x}")));
var child2 = new TreeNode(new Text("child2"));
var child2Child = new TreeNode(new Text("child2Child"));
child2.AddChild(child2Child);
child2Child.AddChild(new TreeNode(new Text("Child 2 child\n child")));
child2.AddNode(child2Child);
child2Child.AddNode(new TreeNode(new Text("Child 2 child\n child")));
var child3 = new TreeNode(new Text("child3"));
var child3Child = new TreeNode(new Text("single leaf\n multiline"));
child3Child.AddChild(new TreeNode(new Calendar(2020, 01)));
child3.AddChild(child3Child);
child3Child.AddNode(new TreeNode(new Calendar(2020, 01)));
child3.AddNode(child3Child);
var children = new List<TreeNode> { new(new Text("child1"), nestedChildren), child2, child3 };
var root = new TreeNode(new Text("Root node"), children);
var tree = new Tree().AddChild(root).AddChild(child2Child);
var tree = new Tree().AddNode(root).AddNode(child2Child);
// When
console.Render(tree);
@@ -70,7 +70,7 @@ namespace Spectre.Console.Tests.Unit
// Given
var console = new FakeConsole(width: 80);
var root = new TreeNode(new Text("Root node"), Enumerable.Empty<TreeNode>());
var tree = new Tree().AddChild(root);
var tree = new Tree().AddNode(root);
// When
console.Render(tree);

15
src/Spectre.Console.sln
View File

@@ -78,6 +78,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Spectre.Console.Testing", "
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Plugins", "Plugins", "{E0E45070-123C-4A4D-AA98-2A780308876C}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Trees", "..\examples\Console\Trees\Trees.csproj", "{CA7AF967-3FA5-4CB1-9564-740CF4527895}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
@@ -412,6 +414,18 @@ Global
{7D5F6704-8249-46DD-906C-9E66419F215F}.Release|x64.Build.0 = Release|Any CPU
{7D5F6704-8249-46DD-906C-9E66419F215F}.Release|x86.ActiveCfg = Release|Any CPU
{7D5F6704-8249-46DD-906C-9E66419F215F}.Release|x86.Build.0 = Release|Any CPU
{CA7AF967-3FA5-4CB1-9564-740CF4527895}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{CA7AF967-3FA5-4CB1-9564-740CF4527895}.Debug|Any CPU.Build.0 = Debug|Any CPU
{CA7AF967-3FA5-4CB1-9564-740CF4527895}.Debug|x64.ActiveCfg = Debug|Any CPU
{CA7AF967-3FA5-4CB1-9564-740CF4527895}.Debug|x64.Build.0 = Debug|Any CPU
{CA7AF967-3FA5-4CB1-9564-740CF4527895}.Debug|x86.ActiveCfg = Debug|Any CPU
{CA7AF967-3FA5-4CB1-9564-740CF4527895}.Debug|x86.Build.0 = Debug|Any CPU
{CA7AF967-3FA5-4CB1-9564-740CF4527895}.Release|Any CPU.ActiveCfg = Release|Any CPU
{CA7AF967-3FA5-4CB1-9564-740CF4527895}.Release|Any CPU.Build.0 = Release|Any CPU
{CA7AF967-3FA5-4CB1-9564-740CF4527895}.Release|x64.ActiveCfg = Release|Any CPU
{CA7AF967-3FA5-4CB1-9564-740CF4527895}.Release|x64.Build.0 = Release|Any CPU
{CA7AF967-3FA5-4CB1-9564-740CF4527895}.Release|x86.ActiveCfg = Release|Any CPU
{CA7AF967-3FA5-4CB1-9564-740CF4527895}.Release|x86.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
@@ -443,6 +457,7 @@ Global
{5734CB0C-CF2A-44E1-B017-AEFA34A4C39C} = {42792D7F-0BB6-4EE1-A314-8889305A4C48}
{E9C02C5A-710C-4A57-A008-E3EAC89305CC} = {42792D7F-0BB6-4EE1-A314-8889305A4C48}
{F83CB4F1-95B8-45A4-A415-6DB5F8CA1E12} = {42792D7F-0BB6-4EE1-A314-8889305A4C48}
{CA7AF967-3FA5-4CB1-9564-740CF4527895} = {F0575243-121F-4DEE-9F6B-246E26DC0844}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {5729B071-67A0-48FB-8B1B-275E6822086C}

2
src/Spectre.Console/Extensions/BarGraphExtensions.cs
View File

@@ -72,7 +72,7 @@ namespace Spectre.Console
foreach (var item in items)
{
AddItem<T>(chart, item);
AddItem(chart, item);
}
return chart;

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

@@ -1,3 +1,6 @@
using System;
using Spectre.Console.Rendering;
namespace Spectre.Console
{
/// <summary>
@@ -6,21 +9,68 @@ namespace Spectre.Console
public static class HasTreeNodeExtensions
{
/// <summary>
/// Adds a child to the end of the node's list of children.
/// Adds a child 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="child">Child to be added.</param>
/// <param name="renderable">The renderable to add.</param>
/// <returns>The same instance so that multiple calls can be chained.</returns>
public static T AddChild<T>(this T obj, TreeNode child)
public static T AddNode<T>(this T obj, IRenderable renderable)
where T : class, IHasTreeNodes
{
if (obj is null)
{
throw new System.ArgumentNullException(nameof(obj));
throw new ArgumentNullException(nameof(obj));
}
obj.Children.Add(child);
obj.Children.Add(new TreeNode(renderable));
return obj;
}
/// <summary>
/// Adds a child 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>
/// <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)
where T : class, IHasTreeNodes
{
if (obj is null)
{
throw new ArgumentNullException(nameof(obj));
}
if (config is null)
{
throw new ArgumentNullException(nameof(config));
}
var node = new TreeNode(renderable);
config(node);
obj.Children.Add(node);
return obj;
}
/// <summary>
/// Adds a child 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="node">The tree node to add.</param>
/// <returns>The same instance so that multiple calls can be chained.</returns>
public static T AddNode<T>(this T obj, TreeNode node)
where T : class, IHasTreeNodes
{
if (obj is null)
{
throw new ArgumentNullException(nameof(obj));
}
obj.Children.Add(node);
return obj;
}
}

2
src/Spectre.Console/Extensions/Obsolete/ObsoleteAlignableExtensions.cs
View File

@@ -22,7 +22,7 @@ namespace Spectre.Console
{
if (obj is null)
{
throw new System.ArgumentNullException(nameof(obj));
throw new ArgumentNullException(nameof(obj));
}
obj.Alignment = alignment;

4
src/Spectre.Console/Internal/StackFrameInfo.cs
View File

@@ -16,8 +16,8 @@ namespace Spectre.Console.Internal
string method, List<(string Type, string Name)> parameters,
string? path, int? lineNumber)
{
Method = method ?? throw new System.ArgumentNullException(nameof(method));
Parameters = parameters ?? throw new System.ArgumentNullException(nameof(parameters));
Method = method ?? throw new ArgumentNullException(nameof(method));
Parameters = parameters ?? throw new ArgumentNullException(nameof(parameters));
Path = path;
LineNumber = lineNumber;
}

2
src/Spectre.Console/Widgets/Panel.cs
View File

@@ -55,7 +55,7 @@ namespace Spectre.Console
/// <param name="content">The panel content.</param>
public Panel(IRenderable content)
{
_child = content ?? throw new System.ArgumentNullException(nameof(content));
_child = content ?? throw new ArgumentNullException(nameof(content));
}
/// <inheritdoc/>

4
src/Spectre.Console/Widgets/Tree.cs
View File

@@ -73,7 +73,7 @@ namespace Spectre.Console
var root = new TreeNode(Text.Empty);
foreach (var node in Nodes)
{
root.AddChild(node);
root.AddNode(node);
}
return MeasureAtDepth(context, maxWidth, root, depth: 0);
@@ -97,7 +97,7 @@ namespace Spectre.Console
var root = new TreeNode(Text.Empty);
foreach (var node in Nodes)
{
root.AddChild(node);
root.AddNode(node);
}
return Enumerable.Empty<Segment>()