From 995ef10b8ba0d62a9cc0c78f04972c745b22d840 Mon Sep 17 00:00:00 2001 From: Setenay <setenay.guner@wsu.edu> Date: Fri, 4 Nov 2022 01:21:18 -0700 Subject: [PATCH] Created a Columns widget documentation (#1044) --- docs/input/widgets/columns.md | 54 +++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 docs/input/widgets/columns.md diff --git a/docs/input/widgets/columns.md b/docs/input/widgets/columns.md new file mode 100644 index 0000000..26ebba6 --- /dev/null +++ b/docs/input/widgets/columns.md @@ -0,0 +1,54 @@ +Title: Columns +Description: "Use **Columns** to render widgets in vertical columns to the console." +Highlights: + - Custom colors + - Labels + - Use your own data with a converter. +Reference: T:Spectre.Console.Columns + +--- + +Use `Columns` to render widgets in vertical columns to the console. + +<?# AsciiCast cast="columns" /?> + +## Usage + +### Basic usage + +```csharp +// Render two items on separate columns to Console +AnsiConsole.Write(new Columns( + new Text("Item 1"), + new Text("Item 2") + )); +``` + +### Add items from an IEnumerable + +```csharp +// Create a list of Items +var columns = new List<Text>(){ + new Text("Item 1"), + new Text("Item 2"), + new Text("Item 3") + }; + +// Render each item in list on separate line +AnsiConsole.Write(new Columns(columns)); +``` + +### Apply custom styles to each column + +```csharp +// Create a list of Items, apply separate styles to each +var columns = new List<Text>(){ + new Text("Item 1", new Style(Color.Red, Color.Black)), + new Text("Item 2", new Style(Color.Green, Color.Black)), + new Text("Item 3", new Style(Color.Blue, Color.Black)) +}; + +// Renders each item with own style +AnsiConsole.Write(new Columns(columns)); +``` +