tomnattle / table-to-csv

A lightweight Javascript library for exporting HTML tables to a CSV file.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TableToCSV

Demo

TableToCSV is a lightweight, dependency-free Javascript library developed by Goutham for exporting HTML tables to a CSV file. TableToCSV is completely written in TypeScript. It allows you to download the HTML table as a CSV file very quickly. Also, it does not depend on any other library like jQuery.

Things I used.

TypeScript Webpack npm

Example

A basic example of TableToCSV

index.html

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Table To CSV</title>
  </head>
  <body>
    <div id="container">
      <button id="downlodbtn">Download</button>
      <table id="studentTable">
        <thead>
          <tr>
            <th>#</th>
            <th>Student Name</th>
            <th>Age</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <th>1</th>
            <td>Kierra Gentry</td>
            <td>21</td>
          </tr>
          <tr>
            <th>2</th>
            <td>Alden Cantrell</td>
            <td>22</td>
          </tr>
          <tr>
            <th>3</th>
            <td>Thomas Crane</td>
            <td>22</td>
          </tr>
          <tr>
            <th>4</th>
            <td>Miranda Shaffer</td>
            <td>21</td>
          </tr>
          <tr>
            <th>5</th>
            <td>Lizeth Daniels</td>
            <td>24</td>
          </tr>
        </tbody>
      </table>
    </div>
  </body>
  <script src="table-to-csv.min.js"></script>
  <script src="main.js"></script>
</html>

main.js

function main() {
  const tableToCSV = new TableToCSV("#studentTable", {
    filename: "student-report-2021.csv",
    delimiter: ",", //delimiter (optional) default value ","
    ignoreColumns: [0], //column index (optional)
  });
  document.querySelector("#downlodbtn").addEventListener("click", (e) => {
    tableToCSV.download();
  });
}
main();

that's it, simple right 😎

Build

To build the library from source, clone the project from github.

$ git clone https://github.com/gouthams96/table-to-csv.git

To install all the dependencies and build the library, run following commands in the root of the project.

$ cd table-to-csv
$ npm install

Then, the project can be build running:

$ npm run build

Contribute

Contributions to the TableToCSV is are very welcome!.

About

A lightweight Javascript library for exporting HTML tables to a CSV file.

License:MIT License


Languages

Language:TypeScript 85.7%Language:JavaScript 14.3%