https://github.com/victornpb/asciitable.js
Generate a ASCII Table from a bidimensional array of strings
https://github.com/victornpb/asciitable.js
ascii-table javascript-library serialization string-manipulation table tabular-data
Last synced: 3 months ago
JSON representation
Generate a ASCII Table from a bidimensional array of strings
- Host: GitHub
- URL: https://github.com/victornpb/asciitable.js
- Owner: victornpb
- License: mit
- Created: 2017-04-09T02:34:40.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-04T11:44:11.000Z (over 2 years ago)
- Last Synced: 2025-03-19T03:06:55.604Z (3 months ago)
- Topics: ascii-table, javascript-library, serialization, string-manipulation, table, tabular-data
- Language: JavaScript
- Homepage:
- Size: 1.46 MB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# asciitable.js
[](LICENSE)
[](package.json)
[](https://www.codefactor.io/repository/github/victornpb/asciitable.js)
[](https://coveralls.io/github/victornpb/asciitable.js)
[](https://www.npmjs.com/package/asciitable.js)
[](https://www.npmjs.com/package/asciitable.js)
[](https://www.npmjs.com/package/asciitable.js)
[](https://www.npmjs.com/package/asciitable.js)
Generate a ASCII Table from a bidimensional array of strings
Live Test: https://jsfiddle.net/Victornpb/3j7wt2a1/show/
#### Source
```js
const matrix = [
['ID', '^Price', '^Amount', '^Column D', '^Column E'],
null, // horizontal line
['1', '$ 100.00', '0', 'Very long text on this cell', '^1'],
['2', '$ 100.00', '10', 'Right aligned', '123456789'],
];
const table = asciitable(matrix);
```
```
| ID | Price | Amount | Column D | Column E |
|----|----------|---------|-----------------------------|-----------|
| 1 | $ 100.00 | 0 | Very long text on this cell | 1 |
| 2 | $ 100.00 | 10 | Left aligned | 123 |
| 3 | $ 100.00 | 100 | Centered | 12345 |
| 4 | $ 100.00 | 1000 | Right aligned | 123456789 |
```
Default style generates a table compatible with GitHub flavored md
| ID | Price | Amount | Column D | Column E |
|----|----------|---------|-----------------------------|-----------|
| 1 | $ 100.00 | 0 | Very long text on this cell | 1 |
| 2 | $ 100.00 | 10 | Left aligned | 123 |
| 3 | $ 100.00 | 100 | Centered | 12345 |
| 4 | $ 100.00 | 1000 | Right aligned | 123456789 |
## Installation
### [NPM](https://www.npmjs.com/package/asciitable.js)
npm install asciitable.js
### [Yarn](https://github.com/yarnpkg/yarn)
yarn add asciitable.js
### CDN
## Packages
| File | Module Type | Transpiled | Source Maps |
|-------------------------|-------------|------------|-------------|
| dist/asciitable.d.ts | es | No | No |
| dist/asciitable.esm.mjs | esm | No | No |
| dist/asciitable.cjs.js | cjs | Yes | Yes |
| dist/asciitable.esm.js | esm | Yes | Yes |
| dist/asciitable.js | umd | Yes | Yes |
# Customizable style
Customizer: https://jsfiddle.net/Victornpb/3j7wt2a1/
```
| ID | Price | Amount | Column D | Column E |
|————|——————————|—————————|—————————————————————————————|———————————|
| 1 | $ 100.00 | 0 | Very long text on this cell | 1 |
| 2 | $ 100.00 | 10 | Left aligned | 123 |
| 3 | $ 100.00 | 100 | Centered | 12345 |
| 4 | $ 100.00 | 1000 | Right aligned | 123456789 |
ID| Price |Amount | Column D |Column E
--|--------|-------|---------------------------|---------
1|$ 100.00| 0|Very long text on this cell| 1
2|$ 100.00| 10|Left aligned | 123
3|$ 100.00| 100| Centered | 12345
4|$ 100.00| 1000| Right aligned|123456789
|ID| Price |Amount | Column D |Column E |
|--+--------+-------+---------------------------+---------|
| 1|$ 100.00| 0|Very long text on this cell| 1 |
| 2|$ 100.00| 10|Left aligned | 123 |
| 3|$ 100.00| 100| Centered | 12345 |
| 4|$ 100.00| 1000| Right aligned|123456789|
│ ID │ Price │ Amount │ Column D │ Column E │
│────┼──────────┼─────────┼─────────────────────────────┼───────────│
│ 1 │ $ 100.00 │ 0 │ Very long text on this cell │ 1 │
│ 2 │ $ 100.00 │ 10 │ Left aligned │ 123 │
│ 3 │ $ 100.00 │ 100 │ Centered │ 12345 │
│ 4 │ $ 100.00 │ 1000 │ Right aligned │ 123456789 │
║ ID │ Price │ Amount │ Column D │ Column E ║
║────┼──────────┼─────────┼─────────────────────────────┼───────────║
║ 1 │ $ 100.00 │ 0 │ Very long text on this cell │ 1 ║
║ 2 │ $ 100.00 │ 10 │ Left aligned │ 123 ║
║ 3 │ $ 100.00 │ 100 │ Centered │ 12345 ║
║ 4 │ $ 100.00 │ 1000 │ Right aligned │ 123456789 ║
ID Price Amount Column D Column E
──── ────────── ───────── ───────────────────────────── ───────────
1 $ 100.00 0 Very long text on this cell 1
2 $ 100.00 10 Left aligned 123
3 $ 100.00 100 Centered 12345
4 $ 100.00 1000 Right aligned 123456789
ID Price Amount Column D Column E
1 $ 100.00 0 Very long text on this cell 1
2 $ 100.00 10 Left aligned 123
3 $ 100.00 100 Centered 12345
4 $ 100.00 1000 Right aligned 123456789
| ID ' Price ' Amount ' Column D ' Column E |
|'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''|
| 1 ' $ 100.00 ' 0 ' Very long text on this cell ' 1 |
| 2 ' $ 100.00 ' 10 ' Left aligned ' 123 |
| 3 ' $ 100.00 ' 100 ' Centered ' 12345 |
| 4 ' $ 100.00 ' 1000 ' Right aligned ' 123456789 |
ID | Price | Amount | Column D | Column E
~~~~+~~~~~~~~~~+~~~~~~~~~+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+~~~~~~~~~~~
1 | $ 100.00 | 0 | Very long text on this cell | 1
2 | $ 100.00 | 10 | Left aligned | 123
3 | $ 100.00 | 100 | Centered | 12345
4 | $ 100.00 | 1000 | Right aligned | 123456789
| ID | Price | Amount | Column D | Column E |
|````|``````````|`````````|`````````````````````````````|```````````|
| 1 | $ 100.00 | 0 | Very long text on this cell | 1 |
| 2 | $ 100.00 | 10 | Left aligned | 123 |
| 3 | $ 100.00 | 100 | Centered | 12345 |
| 4 | $ 100.00 | 1000 | Right aligned | 123456789 |
|| ID || Price || Amount || Column D || Column E ||
||====||==========||=========||=============================||===========||
|| 1 || $ 100.00 || 0 || Very long text on this cell || 1 ||
|| 2 || $ 100.00 || 10 || Left aligned || 123 ||
|| 3 || $ 100.00 || 100 || Centered || 12345 ||
|| 4 || $ 100.00 || 1000 || Right aligned || 123456789 ||
:║[ ID ]||[ Price ]||[ Amount ]||[ Column D ]||[ Column E ]║:
:║-=-=-=┼┼-=-=-=-=-=-=┼┼-=-=-=-=-=-┼┼-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-┼┼-=-=-=-=-=-=-║:
:║[ 1 ]||[ $ 100.00 ]||[ 0 ]||[ Very long text on this cell ]||[ 1 ]║:
:║[ 2 ]||[ $ 100.00 ]||[ 10 ]||[ Left aligned ]||[ 123 ]║:
:║[ 3 ]||[ $ 100.00 ]||[ 100 ]||[ Centered ]||[ 12345 ]║:
:║[ 4 ]||[ $ 100.00 ]||[ 1000 ]||[ Right aligned ]||[ 123456789 ]║:
```
## Horizontal Line
You can add a horizontal line, by just adding a `null` row.
## Alignment
You can align text right, left, and center.
Just prepend the string with one of the following characters:
- `<` to align Left
- `>` to align Right
- `^` to align Center
Example
"I'm aligned right"
"^I'm centered"
# Customizations
Check out the Theme generator fiddle -> https://jsfiddle.net/Victornpb/3j7wt2a1/show/
## Options
It does allow a fairly amount of customization, by changing the defaults via options parameter.
Defaults:
```js
{
row: {
paddingLeft: "|", //before first column
paddingRight: "|", //after last column
colSeparator: "|", //between each column
lineBreak: "\n"
},
cell: {
paddingLeft: " ",
paddingRight: " ",
defaultAlignDir: 1 //left=-1 center=0 right=1
},
hr: { //horizontal line
str: "—",
colSeparator: "|"
}
}
```
## Dependencies
This module does not depend on anything. You can use it on a browser or node enviroment.
### Compability
It should work on anything that supports ECMAScript3 or above. Including IE6.
## Suggestions / Questions
File a [issue](https://github.com/victornpb/asciitable.js/issues) on this repository.
## License
The code is available under the [MIT](LICENSE) license.