Skip to content

Commit

Permalink
Created a Columns widget documentation (#1044)
Browse files Browse the repository at this point in the history
  • Loading branch information
wguner authored Nov 4, 2022
1 parent 4ea64cc commit 995ef10
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions docs/input/widgets/columns.md
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));
```

0 comments on commit 995ef10

Please sign in to comment.