https://github.com/derekeder/csv-to-html-table
:arrow_down_small: Display any CSV (comma separated values) file as a searchable, filterable, pretty HTML table
https://github.com/derekeder/csv-to-html-table
Last synced: 23 days ago
JSON representation
:arrow_down_small: Display any CSV (comma separated values) file as a searchable, filterable, pretty HTML table
- Host: GitHub
- URL: https://github.com/derekeder/csv-to-html-table
- Owner: derekeder
- License: mit
- Created: 2015-06-13T19:23:11.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-03-08T12:41:14.000Z (over 1 year ago)
- Last Synced: 2025-05-10T10:04:57.048Z (29 days ago)
- Language: CSS
- Homepage: http://derekeder.github.io/csv-to-html-table/
- Size: 307 KB
- Stars: 888
- Watchers: 41
- Forks: 332
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - derekeder/csv-to-html-table - :arrow_down_small: Display any CSV (comma separated values) file as a searchable, filterable, pretty HTML table (CSS)
README
# CSV to HTML Table
Display any CSV file as a searchable, filterable, pretty [HTML table](https://www.scaler.com/topics/html/tables-in-html/). Done in 100% JavaScript.
Check out the working demo: https://csv-to-html-table.netlify.app/
## Usage
#### 1. Clone this repository (in the command line)
``` bash
git clone [email protected]:derekeder/csv-to-html-table.git
cd csv-to-html-table
```
#### 2. Add your CSV file to the `data/` folder
#### 3. In `index.html` set your options in the `CsvToHtmlTable.init()` function
``` html
CsvToHtmlTable.init({
csv_path: 'data/Health Clinics in Chicago.csv',
element: 'table-container',
allow_download: true,
csv_options: {separator: ',', delimiter: '"'},
datatables_options: {"paging": false}
});
```
##### Available options
* `csv_path` Path to your CSV file.
* `element` The HTML element to render your table to. Defaults to `table-container`
* `allow_download` if true, shows a link to download the CSV file. Defaults to `false`
* `csv_options` jQuery CSV configuration. Use this if you want to use a custom `delimiter` or `separator` in your input file. See [their documentation](https://code.google.com/p/jquery-csv/wiki/API#$.csv.toArrays%28%29).
* `datatables_options` DataTables configuration. See [their documentation](http://datatables.net/reference/option/).
* `custom_formatting` **New!** A list of column indexes and custom functions to format your data (see below)
##### Custom formatting
If you want to do custom formatting for one or more column, you can pass in an array of arrays containing the index of the column and a custom function for formatting it. You can pass in multiple formatters and they will be executed in order.
The custom functions must take in one parameter (the value in the cell) and return a HTML string:
Example:
``` html
//my custom function that creates a hyperlink
function format_link(link){
if (link)
return "<a href='" + link + "' target='_blank'>" + link + "</a>";
else
return "";
}
//initializing the table
CsvToHtmlTable.init({
csv_path: 'data/Health Clinics in Chicago.csv',
element: 'table-container',
allow_download: true,
csv_options: {separator: ',', delimiter: '"'},
datatables_options: {"paging": false},
custom_formatting: [[4, format_link]] //execute the function on the 4th column of every row
});
```
Note that you should take care about HTML escaping to avoid [XSS](https://www.owasp.org/index.php/Cross-site_Scripting_(XSS)) or broken layout.
jQuery has a nice function [text()](https://api.jquery.com/text/) which safely escapes HTML from value.
#### 4. Run it
You can run this locally using this handy python command:
```bash
python -m SimpleHTTPServer
```
...or with Python 3:
```bash
python -m http.server
```
navigate to http://localhost:8000/
#### 5. Deploy it
**GitHub pages** You can host your table on GitHub pages for free! Once you've made all your changes and committed them, push everything in the `master` branch to `gh-pages` which automatically enables GitHub pages.
```bash
git push origin master:gh-pages
```
Then navigate to http://your-github-username.github.io/csv-to-html-table/
Read more on working with [GitHub pages projects](https://help.github.com/articles/user-organization-and-project-pages/#project-pages).
**Web server** This project should work on any web server. Upload this entire project (including all the `css`, `data`, `fonts` and `js` folders) to a public folder on your server using FTP.
#### 6. iframe it (optional)
Want to embed your nifty table on your website? You can use an [iframe](http://www.w3schools.com/tags/tag_iframe.asp). Once you've deployed your table (above in step 5) you can link to it in an iframe right in your HTML.
```html
```
## Dependencies
* [Bootstrap 4](http://getbootstrap.com/) - Responsive HTML, CSS and Javascript framework
* [jQuery](https://jquery.com/) - a fast, small, and feature-rich JavaScript library
* [jQuery CSV](https://github.com/evanplaice/jquery-csv/) - Parse CSV (Comma Separated Values) to Javascript arrays or dictionaries.
* [DataTables](http://datatables.net/) - add advanced interaction controls to any HTML table.
## Common issues/troubleshooting
If your table isn't displaying any data, try the following:
1. Use the [Chrome developer console](https://developers.google.com/chrome-developer-tools/docs/console) or install [Firebug](http://getfirebug.com/) for FireFox. This will allow you to debug your javascript.
1. Open your table in the browser and open the javascript console
* Chrome developer console on a Mac: Option+Command+J
* Chrome developer console on a PC: Control+Shift+J
* Firebug in Firefox: Tools => Web Developer => Firebug => Open Firebug)
1. If you do see javascript errors, the error will tell you what line it is failing on. Best to start by going there!
## Errors / Bugs
If something is not behaving intuitively, it is a bug, and should be reported.
Report it here: https://github.com/derekeder/csv-to-html-table/issues
## Contributors
* [Derek Eder](http://derekeder.com) - primary contributor
* [ychaouche](https://github.com/ychaouche) - [javascript tag fixes](https://github.com/derekeder/csv-to-html-table/pull/30)
* [Freddy Martinez](https://github.com/b-meson) - [localized javascript libraries](https://github.com/derekeder/csv-to-html-table/pull/17)
* [Sergey Ponomarev](https://github.com/stokito) - [CSV escaped in HTML output](https://github.com/derekeder/csv-to-html-table/pull/60)
* [djibe](https://github.com/djibe) - [Bootstrap 4 and latest DataTables](https://github.com/djibe/csv-to-html-table)
## Note on Patches/Pull Requests
* Fork the project.
* Make your feature addition or bug fix.
* Send a pull request. Bonus points for topic branches.
## Copyright
Copyright (c) 2018 Derek Eder. Released under the [MIT License](https://github.com/derekeder/csv-to-html-table/blob/master/LICENSE).