-
-
Notifications
You must be signed in to change notification settings - Fork 499
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Created a Columns widget documentation (#1044)
- Loading branch information
Showing
1 changed file
with
54 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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)); | ||
``` | ||
|