4.1.1 • Published 4 years ago

tec-table v4.1.1

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

tty-table 端子台

Build Status 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)

ParamTypeDescription
headerarrayPer-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
rowsarrayYour data. An array of arrays or objects. See examples
optionsobjectGlobal table configuration. See available properties

header array of objects

ParamTypeDescription
aliasstringText to display in column header cell
alignstringdefault: "center"
colorstringdefault: terminal default color
footerAlignstringdefault: "center"
footerColorstringdefault: terminal default color
formatterfunction(cellValue, columnIndex, rowIndex, rowData, inputDataRuns 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 configurefunction(object)Configure cell properties. For example: this.configure({ truncate: false, align: "left" }) More here.
@formatter resetStylefunction(cellValue)Removes ANSI escape sequences. For example: this.resetStyle(" myText") // "myText"
@formatter stylefunction(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
headerAlignstringdefault: "center"
headerColorstringdefault: terminal's default color
marginLeftintegerdefault: 0
marginTopintegerdefault: 0
paddingBottomintegerdefault: 0
paddingLeftintegerdefault: 1
paddingRightintegerdefault: 1
paddingTopintegerdefault: 0
valuestringName of the property to display in each cell when data passed as an array of objects
widthstring || integerdefault: "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 array

  • 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

ParamTypeDescription
borderStylestringdefault: "solid". options: "solid", "dashed", "none"
borderColorstringdefault: terminal default color
colorstringdefault: terminal default color
compactbooleandefault: false Removes horizontal borders when true.
defaultErrorValuemixeddefault: '�'
defaultValuemixeddefault: '?'
errorOnNullbooleandefault: false
truncatemixeddefault: 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.
widthstringdefault: "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 Versiontty-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.