tgrid

package

v0.0.4 Latest Latest Go to latest Published: Oct 17, 2023 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package tgrid represents tables as simple ASCII art. Example:

┌──╥──╥──╥───┐
│12║12║12║123│
╞══╬══╬══╬═══╡
│12║12║12║123│
╞══╬══╬══╬═══╡
│12║12║12║123│
└──╨──╨──╨───┘

This section is empty.

This section is empty.

func WordWrap(text []byte, lineWidth int) []byte

type Cell struct {
	Next   int
	Width  int
	Height int
	Lines  []Line
}

func NewCell(fromLines ...Line) *Cell

func NewCellFromBytes(b []byte, lineWidth int) *Cell

func (c *Cell) WriteFiller(w io.Writer, n int) (err error)

func (c *Cell) WriteLine(w io.Writer) (err error)

type CellGenerator func() (*Cell, error)

type Grid []Row

Grid is an ASCII rendering of table data.

func NewGrid(columns, rows int, from CellGenerator) (Grid, error)

func (g Grid) MiddleBorder() []byte

func (g Grid) Normalize()

func (g Grid) Write(w io.Writer) (n int, err error)

func (g Grid) WriteBottomBorder(w io.Writer) (n int, err error)

func (g Grid) WriteTopBorder(w io.Writer) (n int, err error)

type Line []byte

type Row []*Cell

func (r Row) Height() (height int)

func (r Row) Write(w io.Writer) (n int, err error)