1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
# term-grid
<p>
<a href="https://github.com/achannarasappa/term-grid/actions"><img src="https://github.com/achannarasappa/term-grid/workflows/test/badge.svg" alt="Build Status"></a>
<a href='https://coveralls.io/github/achannarasappa/term-grid?branch=main'><img src='https://coveralls.io/repos/github/achannarasappa/term-grid/badge.svg?branch=main' alt='Coverage Status' /></a>
<a href='https://goreportcard.com/badge/github.com/achannarasappa/term-grid'><img src='https://goreportcard.com/badge/github.com/achannarasappa/term-grid' alt='Report Card' /></a>
</p>
Position text and visuals in a grid layout for terminal UIs (TUIs) with familiar web semantics
## Features
* **Flex Layout** - dynamically resize cells to use available space
* **Responsive** - show or hide cells dynamically based on grid size
* **Alignment** - align text to the right of left of a cell
* **Overflow/Wrap** - set whether text should be hidden, wrap on word, or wrap unconditionally when width exceeds the cell width
* **Margins** - set width vertically and horizontally between cells
## Install
```sh
go get github.com/achannarasappa/term-grid
```
## Quick Start
```go
// main.go
package main
import (
"fmt"
. "github.com/achannarasappa/term-grid"
)
func main() {
out := Render(
Grid{
GutterVertical: 2,
GutterHorizontal: 5,
Rows: []Row{
{
Width: 100,
Cells: []Cell{
{Width: 10, Text: "term-grid is awesome!", Overflow: WrapWord},
{Width: 10, Text: "everything to the right", Overflow: Wrap, Align: Right},
{Width: 20, Text: "To Do:\n- take out trash\n- book my flight\n- workout", Overflow: WrapWord},
{Text: "I'm baby pitchfork iPhone tilde umami man braid"},
},
},
},
})
fmt.Print(out)
}
```
```sh
$ go run main.go
term-grid everything To Do: I'm baby pitchfork iPhone tilde umami man bra
is to the rig - take out trash
awesome! ht - book my flight
- workout
```
|
