https://github.com/serkonda7/termtable

Simple and highly customizable library to display tables in the terminal.
https://github.com/serkonda7/termtable

ascii cli hacktoberfest table terminal v vlang

Last synced: 9 months ago
JSON representation

Simple and highly customizable library to display tables in the terminal.

• Host: GitHub
• URL: https://github.com/serkonda7/termtable
• Owner: serkonda7
• License: mit
• Archived: true
• Created: 2020-10-21T20:56:02.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-06-20T14:48:58.000Z (over 2 years ago)
• Last Synced: 2024-11-18T21:46:45.955Z (about 1 year ago)
• Topics: ascii, cli, hacktoberfest, table, terminal, v, vlang
• Language: V
• Homepage:
• Size: 248 KB
• Stars: 43
• Watchers: 5
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-v - termtable - V Terminal Tables: Simple and highly customizable library to display tables in the terminal. (Libraries / Command line interface (CLI) / Terminal / Shell)

README

          
# V Terminal Tables

![CI](https://github.com/serkonda7/termtable/workflows/CI/badge.svg?branch=master)

Simple and highly customizable library to display tables in the terminal.

## Features

- Choose from seven predefined [styles](#predefined-styles)

- Or create any [custom style](#creating-custom-styles) you want

- [Tab support](#tabsize)

- [Unicode support](test/../tests/unicode/cjk.out)

## Installation

`v install serkonda7.termtable`

## Usage

```v

import serkonda7.termtable as tt

fn main() {

	data := [

		['Name', 'Age', 'Sex'],

		['Max', '13', 'male'],

		['Moritz', '12', 'male'],

		['Lisa', '42', 'female'],

	]

	t := tt.Table{

		data: data

		// The following settings are optional and have these defaults:

		style: .grid

		header_style: .bold

		align: .left

		orientation: .row

		padding: 1

		tabsize: 4

	}

	println(t)

}

```

### Predefined Styles

Supported values for `style: ...` are:

- .grid

- .pretty

- .plain

- .simple

- .fancy_grid

- .md

- .rst

`.grid` (default):

![](img/grid.png)

`.pretty`:

![](img/pretty.png)

`.plain`:

![](img/plain.png)

`.simple`:

![](img/simple.png)

`.fancy_grid`:

![](img/fancy_grid.png)

`.md` follows the conventions of [Markdown][md-tables]. It does not add alignment colons though:

![](img/md.png)

`.rst` behaves like the [reStructuredText][rst-tables] simple table format:

![](img/rst.png)

### Header Style

```v

// header_style: ...

```

| `.bold (default)` | `.plain` |

| :-------: | :-------: |

| ![](img/header_bold.png) | ![](img/header_plain.png) |

### Alignment

```v

// align: ...

| Max    | 13  | male   |  // .left (default)

|  Max   | 13  |  male  |  // .center

|    Max |  13 |   male |  // .right

```

### Orientation

```v

t := tt.Table{

	data: [

		['Name', 'Age'],

		['Max', '13'],

		['Moritz', '12'],

	]

	// orientation: ...

}

println(t)

```

| `.row (default)` | `.column` |

| :-------: | :-------: |

| ![](img/orientation_row.png) | ![](img/orientation_column.png) |

### Padding

Control the count of spaces between the cell border and the item.

```v

// padding: ...

|   Lisa   |   42   |   female   |  // 3

| Lisa | 42 | female |  // 1 (default)

|Lisa|42|female|  // 0

```

### Tabsize

```v

t := tt.Table{

	data: [

		['\tName', 'Sex'],

		['1.\tMax', 'male\t'],

		['2. \tMoritz', '\tmale'],

	]

	// tabsize: ...

}

println(t)

```

| `4 (default)` | `2` | `8` |

| :-------: | :-------: | :-------: |

| ![](img/tab-4.png) | ![](img/tab-2.png) | ![](img/tab-8.png) |

### Creating Custom Styles

To create a custom style set the tables style property to `style: .custom`

and specify `custom_style: tt.StyleConfig{...}`.

#### `StyleConfig` Struct

```v

topline      tt.Sepline{...}

headerline   tt.Sepline{...}

middleline   tt.Sepline{...}

bottomline   tt.Sepline{...}

colsep       string

fill_padding bool = true

```

#### `Sepline` Struct

```v

left  string

right string

cross string

sep   string

```

## Acknowledgements

- Images were made with [carbon][carbon-repo] and optimized with [image-actions][image-actions-repo]

## License

Licensed under the [MIT License](LICENSE.md)

[md-tables]: https://www.markdownguide.org/extended-syntax#tables

[rst-tables]: https://docutils.sourceforge.io/docs/user/rst/quickref.html#tables

[carbon-repo]: https://github.com/carbon-app/carbon

[image-actions-repo]: https://github.com/calibreapp/image-actions