react-native-console-table

!NPM Version
!NPM Unpacked Size




>This package is designed to display an array of objects (with the same interface) as a table in the terminal.

🗃️ Installation

npm i react-native-console-table

$3

>⚠️ For correct table border display, ensure that a monospaced font is set for the terminal.\
>You can do this in VSCode: File > Preferences > Settings > Font Family enter 'Courier New', monospace'.

``typescript
import { consoleTable } from 'react-native-console-table';

interface IDataMock {
name: string;
age: number;
country: string;
job: string;
}

const dataMock: IDataMock[] = [
{ name: 'Alice', age: 25, country: 'USA', job: 'Developer' },
{ name: 'Bob', age: 30, country: 'UK', job: 'Driver' },
{ name: 'Charlie', age: 28, country: 'Canada', job: 'Engineer' },
{ name: 'Charlie', age: 28, country: 'Canada', job: 'Manager' },
{ name: 'Bob', age: 30, country: 'UK', job: 'Developer' }
];

consoleTable(dataMock);
or
consoleTable(dataMock, {...Props settings});
`

Props settings

| Name | type | Description |
|:---| :--- | :---|
| title| string \| undifined | Title for table.
| selectionTitle | string \| undifined | Title highlight type selection.
| selectionHeader | string \| undifined | Header highlight type selection.
| isShowLine | boolean | Table with or without data separation lines.
| sing | string \| undifined | Icon selection for the table.
| filter | string[] \| undifined | An array of object keys for filtering and excluding columns with these keys from the table.

---

$3

>By default, without a settings object.

`typescript
consoleTable(dataMock);
`



---

$3

>Table display with highlighted header.

`typescript
consoleTable(dataMock, {selectionHeader: 'background_magenta'});
`



---

$3

>Table display with highlighted header and data separation lines.

`typescript
consoleTable(dataMock, {selectionHeader: 'background_magenta', isShowLine: true});
`



---

$3

>Table display with yellow headers, data separation lines, and an icon.

`typescript
consoleTable(dataMock, {selectionHeader: 'text_yellow', isShowLine: true, sing: 'rocket'});
`



---

$3

>Table with highlighted header, highlighted top row, data separation lines, and an icon.

`typescript
consoleTable(dataMock,
{
title: 'Table User',
sing: 'rocket',
selectionTitle: 'background_green',
selectionHeader: 'background_magenta',
isShowLine: true
}
);
`



---

$3

>You can pass keys as an array to exclude specific columns from the table displayed in the console.

`typescript
consoleTable(dataMock,
{
title: 'Table User',
sing: 'box',
selectionTitle: 'background_green',
selectionHeader: 'background_magenta',
filter: ['job', 'country']
}
);
``