https://github.com/diyorumarkulov/tablerjs
Library with tools and utils to create tables.
https://github.com/diyorumarkulov/tablerjs
library node nodejs table tools typescript typescript-library
Last synced: 3 months ago
JSON representation
Library with tools and utils to create tables.
- Host: GitHub
- URL: https://github.com/diyorumarkulov/tablerjs
- Owner: DiyorUmarkulov
- License: mit
- Created: 2024-09-16T10:37:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-18T08:40:41.000Z (almost 2 years ago)
- Last Synced: 2025-10-12T14:22:46.738Z (9 months ago)
- Topics: library, node, nodejs, table, tools, typescript, typescript-library
- Language: TypeScript
- Homepage:
- Size: 66.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TablerJS
**TablerJS** is a simple and lightweight library for generating tables from provided data. It allows you to easily define columns and build tables with custom rows.
## Installation
You can install TablerJS using npm:
```bash
npm install tablerjs
```
or with yarn:
```bash
yarn add tablerjs
```
## Usage
### Define Table Structure
To create a table, you first need to define the columns by passing an object with column names and the number of columns to display into the `table` function.
Example:
```javascript
import { table } from "tablerjs";
export const exampleTable = table(
{
col1: "Column 1",
col2: "Lorem ipsum",
},
);
```
### Adding Rows to the Table
To populate a table with data, pass an array of strings to a previously defined table function. Each string must correspond to the keys of certain columns. If any column is not filled and you use TypeScript, it will throw an error and throw a type error.
Example:
```javascript
const rows = [
{
col1: "Row 1",
col2: "Col 2 value",
},
{
col1: "Row 2",
col2: "Col 2 value",
},
];
const tableView = exampleTable(rows);
```
### Full Example
```javascript
import { table } from "tablerjs";
// Define a table with two columns
export const exampleTable = table(
{
col1: "Column 1",
col2: "Lorem ipsum",
},
);
// Array of rows to populate the table
const rows = [
{
col1: "Row 1",
col2: "Col 2 value",
},
{
col1: "Row 2",
col2: "Col 2 value",
},
];
// Generate the table from the provided rows
const tableView = exampleTable(rows);
// tableView now contains the table structure with the given data
```
### Result
### Arguments
- **`header`** (object): Defines the structure of the table where the keys are the column identifiers and the values are the column headers.
## Support
If you have any questions or issues, feel free to open an issue in the repository or reach out to the author on GitHub.
## License
This project is licensed under the MIT License.