npmpackage.info

Gathering detailed insights and metrics for tty-table

Other packages similar to tty-table

as-table

1.0.55

A simple function that print objects / arrays as ASCII tables. Handles ANSI styling and weird 💩 Unicode emoji symbols – they won't break the layout.

@tty-pt/types

0.5.1

Automate table and filter creation and other things and have your data models in the client

table-string

1.2.1

Generate nice tables for CLI / console output.

inquirer-table

1.0.1

A table prompt for Inquirer.js.

Gathering detailed insights and metrics for tty-table

tty-table - 4.2.3 | npmpackage.info

tty-table

Terminal table for Windows, Linux, and MacOS. Written in nodejs. Also works in browser console. Word wrap, padding, alignment, colors, Asian character support, per-column callbacks, and you can pass rows as objects or arrays. Backwards compatible with Automattic/cli-table.

4.2.3

296

MIT

JavaScript

48.54 kB

1.8

Installations

npm install tty-table

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=8.0.0

Node Version

18.16.1

NPM Version

9.8.1 Pull Requests

Open

0

Total

44

Closed

10

Merged

34

Issues

Open

3

Total

54

Closed

51

Releases

v4.1.6

Updated on Jun 10, 2022

View All 1 releases

Languages

JavaScript

JavaScript (100%)

Developer

tecfu

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

296 Stars

447 Commits

31 Forks

7 Watchers

3 Branches

13 Contributors

Updated on Jul 16, 2025

Maintainers

View All 13 Contributors

Package Meta Information

Latest Version

4.2.3

Package Id

tty-table@4.2.3

Unpacked Size

48.54 kB

Size

15.34 kB

File Count

NPM Version

9.8.1

Node Version

18.16.1

Published on

Oct 29, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

tty-table 端子台

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:

1$ git clone https://github.com/tecfu/tty-table && cd tty-table && npm i
2$ 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

View in Chrome or Chromium at http://localhost:8070/examples/browser-example.html using a dockerized apache instance:

1git clone https://github.com/tecfu/tty-table
2cd tty-table
3docker run -dit --name tty-table-in-browser -p 8070:80 -v "$PWD":/usr/local/apache2/htdocs/ httpd:2.4

live demo (chrome only): jsfiddle
live demo (chrome only): plnkr
source: examples/browser-example.html

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("[32m myText[39m") // "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

1let header = [{
2  value: "item",
3  headerColor: "cyan",
4  color: "white",
5  align: "left",
6  width: 20
7},
8{
9  value: "price",
10  color: "red",
11  width: 10,
12  formatter: function (value) {
13    let str = `$${value.toFixed(2)}`
14    return (value > 5) ? this.style(str, "green", "bold") : 
15      this.style(str, "red", "underline")
16  }
17}]

rows `array`

Example

each row an array

1const rows = [
2  ["hamburger",2.50],
3]

each row an object

1const rows = [
2  {
3    item: "hamburger",
4    price: 2.50
5  }
6]

footer `array`

Footer is optional

Example

1const footer = [
2  "TOTAL",
3  function (cellValue, columnIndex, rowIndex, rowData) {
4    let total = rowData.reduce((prev, curr) => {
5      return prev + curr[1]
6    }, 0)
7    .toFixed(2)
8
9    return this.style(`$${total}`, "italic")
10  }
11]

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

1const options = {
2  borderStyle: "solid",
3  borderColor: "blue",
4  headerAlign: "center",
5  align: "left",
6  color: "white",
7  truncate: "...",
8  width: "90%"
9}

Table.render() ⇒ `String`

Add method to render table to a string

Example

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

Installation

Terminal:

1$ npm install tty-table -g

Node Module

1$ npm install tty-table

Browser

1import Table from 'https://cdn.jsdelivr.net/gh/tecfu/tty-table/dist/tty-table.esm.js'
2let Table = require('tty-table')   // https://cdn.jsdelivr.net/gh/tecfu/tty-table/dist/tty-table.cjs.js
3let 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

1$ npm test

1$ npm run coverage

Saving the output of new unit tests

1$ npm run save-tests

Dev Tips

To generate vim tags (make sure jsctags is installed globally)

1$ npm run tags

To generate vim tags on file save

1$ 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

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.8

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to tty-table

Other packages similar to tty-table

tty-table

Installations

Developer Guide

Yes

CommonJS

>=8.0.0

18.16.1

9.8.1

Pull Requests

0

44

10

34

Issues

3

54

51

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

tty-table 端子台

Examples

Terminal (Static)

Terminal (Streaming)

Browser & Browser Console

API Reference

Table(header array, rows array, options object)

header array of objects

rows array

footer array

options object

Table.render() ⇒ String

Installation

Version Compatibility

Running tests

Saving the output of new unit tests

Dev Tips

Pull Requests

Packaging as a distributable

License

10

10

2

0

0

0

0

0

0

0

0

1.8

/10

Table(header `array`, rows `array`, options `object`)

header `array of objects`

rows `array`

footer `array`

options `object`

Table.render() ⇒ `String`