tty-table

Node cli table

MIT 90 个版本
table table in bash cli-table terminal table console table cli table console.table ascii table
主页
仓库
提交 Issue
安装
npm install tty-table
yarn add tty-table
pnpm add tty-table
bun add tty-table
README

tty-table

NPM version Coverage Status

Display your data in a table using a terminal, browser, or browser console.

Examples

See here for complete example list

To view all example output:

$ git clone https://github.com/tecfu/tty-table && cd tty-table && npm i
$ npm run view-examples

Terminal (Static)

examples/styles-and-formatting.js

Static

Terminal (Streaming)

$ node examples/data/fake-stream.js | tty-table --format json --header examples/config/header.js

Streaming

  • See the built-in help for the terminal version of tty-table with:
$ tty-table -h

Browser & Browser Console

Browser Console Example



API Reference

Table(header array, rows array, options object)

Param Type Description
header array Per-column configuration. An array of objects, one object for each column. Each object contains properties you can use to configure that particular column. See available properties
rows array Your data. An array of arrays or objects. See examples
options object Global table configuration. See available properties

header array of objects

Param Type Description
alias string Text to display in column header cell
align string default: "center"
color string default: terminal default color
footerAlign string default: "center"
footerColor string default: terminal default color
formatter function(cellValue, columnIndex, rowIndex, rowData, inputData Runs a callback on each cell value in the parent column.
Please note that fat arrow functions () => {} don't support scope overrides, and this feature won't work correctly within them.
@formatter configure function(object) Configure cell properties. For example:
this.configure({ truncate: false, align: "left" }) More here.
@formatter resetStyle function(cellValue) Removes ANSI escape sequences. For example:
this.resetStyle(" myText") // "myText"
@formatter style function(cellValue, effect) Style cell value. For example:
this.style("mytext", "bold", "green", "underline")
For a full list of options in the terminal: chalk. For a full list of options in the browser: kleur
headerAlign string default: "center"
headerColor string default: terminal's default color
marginLeft integer default: 0
marginTop integer default: 0
paddingBottom integer default: 0
paddingLeft integer default: 1
paddingRight integer default: 1
paddingTop integer default: 0
value string Name of the property to display in each cell when data passed as an array of objects
width string || integer default: "auto"
Can be a percentage of table width i.e. "20%" or a fixed number of columns i.e. "20".
When set to the default ("auto"), the column widths are made proportionate by the longest value in each column.
Note: Percentage columns and fixed value colums not intended to be mixed in the same table.

Example

let header = [{
  value: "item",
  headerColor: "cyan",
  color: "white",
  align: "left",
  width: 20
},
{
  value: "price",
  color: "red",
  width: 10,
  formatter: function (value) {
    let str = `$${value.toFixed(2)}`
    return (value > 5) ? this.style(str, "green", "bold") : 
      this.style(str, "red", "underline")
  }
}]


rows array

Example

  • each row an array
const rows = [
  ["hamburger",2.50],
]
  • each row an object
const rows = [
  {
    item: "hamburger",
    price: 2.50
  }
]


  • Footer is optional

Example

const footer = [
  "TOTAL",
  function (cellValue, columnIndex, rowIndex, rowData) {
    let total = rowData.reduce((prev, curr) => {
      return prev + curr[1]
    }, 0)
    .toFixed(2)

    return this.style(`$${total}`, "italic")
  }
]


options object

Param Type Description
borderStyle string default: "solid".
options: "solid", "dashed", "none"
borderColor string default: terminal default color
color string default: terminal default color
compact boolean default: false
Removes horizontal borders when true.
defaultErrorValue mixed default: '�'
defaultValue mixed default: '""'
errorOnNull boolean default: false
truncate mixed default: false
When this property is set to a string, cell contents will be truncated by that string instead of wrapped when they extend beyond of the width of the cell.
For example if:
"truncate":"..."
the cell will be truncated with "..."
Note: tty-table wraps overflowing cell text into multiple lines by default, so you would likely only utilize truncate for extremely long values.
width string default: "100%"
Width of the table. Can be a percentage of i.e. "50%" or a fixed number of columns in the terminal viewport i.e. "100".
Note: When you use a percentage, your table will be "responsive".

Example

const options = {
  borderStyle: "solid",
  borderColor: "blue",
  headerAlign: "center",
  align: "left",
  color: "white",
  truncate: "...",
  width: "90%"
}

Table.render() ⇒ String

Add method to render table to a string

Example

const out = Table(header,rows,options).render()
console.log(out); //prints output


Installation

$ npm install tty-table -g
  • Node Module
$ npm install tty-table
  • Browser
import Table from 'https://cdn.jsdelivr.net/gh/tecfu/tty-table/dist/tty-table.esm.js'
let Table = require('tty-table')   // https://cdn.jsdelivr.net/gh/tecfu/tty-table/dist/tty-table.cjs.js
let Table = TTY_Table;             // https://cdn.jsdelivr.net/gh/tecfu/tty-table/dist/tty-table.umd.js

Version Compatibility

Node Version tty-table Version
8 >= 2.0
0.11 >= 0.0

Running tests

$ npm test

$ npm run coverage

Saving the output of new unit tests

$ npm run save-tests

Dev Tips

  • To generate vim tags (make sure jsctags is installed globally)
$ npm run tags
  • To generate vim tags on file save
$ npm run watch-tags

Pull Requests

Pull requests are encouraged!

  • Please remember to add a unit test when necessary
  • Please format your commit messages according to the "Conventional Commits" specification

If you aren't familiar with Conventional Commits, here's a good article on the topic

TL/DR:

  • feat: a feature that is visible for end users.
  • fix: a bugfix that is visible for end users.
  • chore: a change that doesn't impact end users (e.g. chances to CI pipeline)
  • docs: a change in the README or documentation
  • refactor: a change in production code focused on readability, style and/or performance.

Packaging as a distributable

License

MIT License

Copyright 2015-2020, Tecfu.

版本列表
5.0.0 2025-11-09
4.2.3 2023-10-29
4.2.2 2023-09-30
4.2.1 2023-03-19
4.2.0 2023-03-19
4.1.6 2022-06-10
4.1.5 2021-08-28
4.1.4 2021-08-27
4.1.3 2020-05-07
4.1.2 2020-05-06
4.1.1 2020-03-11
4.1.0 2020-03-11
4.0.0 2020-03-09
3.3.0 2020-03-06
3.2.0 2020-03-02
3.1.0 2020-03-02
3.0.3 2020-02-29
3.0.2 2020-02-29
3.0.1 2020-02-27
3.0.0 2020-02-26
2.8.13 2020-02-27
2.8.12 2020-02-17
2.8.11 2020-02-15
2.8.10 2020-02-14
2.8.9 2020-02-14
2.8.8 2020-02-12
2.8.7 2020-02-09
2.8.6 2020-01-23
2.8.5 2020-01-09
2.8.4 2019-12-28
2.8.3 2019-11-27
2.8.2 2019-11-12
2.8.1 2019-11-03
2.8.0 2019-10-17
2.7.6 2019-08-30
2.7.5 2019-08-28
2.7.4 2019-08-13
2.7.3 2019-07-21
2.7.2 2019-07-21
2.7.1 2019-07-06
2.7.0 2019-01-25
2.6.15 2019-01-15
2.6.14 2019-01-13
2.6.13 2019-01-13
2.6.12 2018-12-21
2.6.11 2018-12-21
2.6.10 2018-12-21
2.6.9 2018-10-04
2.6.8 2018-07-14
2.6.7 2018-06-22
2.6.6 2018-06-22
2.6.5 2018-06-20
2.6.4 2018-06-09
2.6.3 2018-05-12
2.6.2 2018-04-25
2.6.1 2018-04-25
2.6.0 2018-04-09
2.5.9 2018-02-28
2.5.8 2018-02-28
2.5.7 2018-02-28
2.5.6 2018-02-28
2.5.5 2017-07-27
2.5.4 2017-07-27
2.5.3 2017-06-20
2.5.2 2017-06-07
2.5.1 2017-05-28
2.5.0 2017-05-28
2.4.2 2017-05-27
2.4.1 2017-05-27
2.4.0 2017-05-27
2.3.2 2017-05-23
2.3.1 2017-05-22
2.3.0 2017-05-21
2.2.5 2016-11-22
2.2.4 2016-11-22
2.2.3 2016-11-20
2.2.2 2016-11-04
2.2.1 2016-11-04
2.2.0 2016-11-02
2.1.0 2016-06-21
2.0.2 2016-06-01
2.0.1 2016-05-31
2.0.0 2016-05-31
1.1.0 2016-05-04
1.0.7 2015-12-16
1.0.6 2015-07-09
1.0.5 2015-07-08
1.0.4 2015-07-07
1.0.3 2015-07-07
1.0.0 2015-07-07