v3 docs
The simple, easy-to-implement plugin to export HTML tables to xlsx
, xls
, csv
, and txt
files.
Deprecation notice:
Below are the docs for v3.3.13
.
v3.3.13
.Check out v5
for the latest release.
v5
for the latest release.Live Demo
A live, interactive demo can be found on the TableExport webpage.
Getting Started
Download and Setup
To use this plugin, include the jQuery library, FileSaver.js script, and TableExport.js plugin before the closing <body>
tag of your HTML document:
Install with Bower
Install with npm
Dependencies
Required:
jQuery (1.2.1 or higher)
*
*
jQuery dependency requirement is removed as of v4
Optional / Theming:
Bootstrap (3.1.0 or higher)
Add-Ons:
In order to provide Office Open XML SpreadsheetML Format ( .xlsx ) support, you must include the following third-party script to your project before FileSaver.js and TableExport.js.
xlsx.core.js by clarketm
Older Browsers:
To support older browsers ( Chrome < 20, Firefox < 13, Opera < 12.10, IE < 10, Safari < 6 ) include the Blob.js polyfill before the FileSaver.js script.
Until Safari provides native support for either the HTML5 download attribute or service workers, limited xlx
and xlsx
support is provided by including the Blob.js polyfill, albeit the filename will always be labeled Unknown
.
Blob.js by clarketm
Usage
CSS
By default, TableExport.js utilizes the Bootstrap CSS framework to deliver enhanced table and button styling. For non-Bootstrap projects, initialize with the bootstrap
property set to false
.
When used along with Bootstrap, there are four custom classes .xlsx, .xls, .csv, .txt providing button styling for each of the exportable filetypes.
JavaScript
To use the export plugin, just call:
Additional properties can be passed in to customize the look and feel of your tables, buttons, and exported data.
Notice that by default, TableExport will create export buttons for three different filetypes xls, csv, txt. You can choose which buttons to generate by setting the formats
property to the filetypes of your choice.
Note: to use the xlsx filetype, you must include the third-party scripts listed in the Dependencies section.
TableExport supports additional methods (update, reset and remove) to control it after creation.
Properties
A table of available properties and their usage can be found here
Methods
A table of available methods and their usage can be found here
Settings
Each button is assigned a default class and default content based on its respective filetype and corresponding css styles.
Below are additional defaults to support the functionality of the plugin that.
Browser Support
Chrome | Firefox | IE | Opera | Safari * | |
Android | ✓ | ✓ | - | ✓ | - |
iOS | ✓ | - | - | - | ✓ |
Mac OSX | ✓ | ✓ | - | ✓ | ✓ |
Windows | ✓ | ✓ | ✓ | ✓ | ✓ |
*only partial support for xls
and xlsx
: requires third-party dependency (Blob.js)
Live Demo
A live, interactive demo can be found on the TableExport webpage.
Examples:
Customizing Properties
Customizing Settings
Miscellaneous
cell data types
(string
,number
,boolean
,date
)
Skeletons
TableExport + RequireJS skeleton.
TableExport + Flask skeleton.
TableExport + Webpack 1 skeleton.
TableExport + Angular 4 + Webpack 2 skeleton.
License
TableExport.js is licensed under the terms of the Apache-2.0 License
:star: Credits
Special thanks the the following contributors:
John Resig - jQuery
SheetJS - js-xlsx
Eli Grey - FileSaver.js & Blob.js
Last updated