v3 docs

PreviousMigrating from 4.x to 5.x?Nextv4 docs

Last updated 4 years ago

Was this helpful?

v3 docs

The simple, easy-to-implement plugin to export HTML tables to xlsx, xls, csv, and txt files.

Notice: As of May 2017, has be superceded by .

Deprecation notice:

Below are the docs for .

Check out for the latest release.

Live Demo

A live, interactive demo can be found on the webpage.

Getting Started

Download and Setup

To use this plugin, include the library, script, and plugin before the closing <body> tag of your HTML document:

<script src="jquery.js"></script>
<script src="FileSaver.js"></script>
...
<script src="tableexport.js"></script>

Install with Bower

$ bower install tableexport.js

Install with npm

$ npm install tableexport

uncompressed

compressed

CSS

Images

—

uncompressed

compressed

CSS

Images

—

Dependencies

Required:

Optional / Theming:

Add-Ons:

<script src="xlsx.core.js"></script>
<script src="FileSaver.js"></script>
...
<script src="tableexport.js"></script>

Older Browsers:

<script src="xlsx.core.js"></script>
<script src="Blob.js"></script>
<script src="FileSaver.js"></script>
...
<script src="tableexport.js"></script>

Usage

CSS

$("table").tableExport({
  bootstrap: 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:

$("table").tableExport();

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.

/* Defaults */
$("table").tableExport({
  headings: true, // (Boolean), display table headings (th/td elements) in the <thead>
  footers: true, // (Boolean), display table footers (th/td elements) in the <tfoot>
  formats: ["xls", "csv", "txt"], // (String[]), filetype(s) for the export
  fileName: "id", // (id, String), filename for the downloaded file
  bootstrap: true, // (Boolean), style buttons using bootstrap
  position: "bottom", // (top, bottom), position of the caption element relative to table
  ignoreRows: null, // (Number, Number[]), row indices to exclude from the exported file(s)
  ignoreCols: null, // (Number, Number[]), column indices to exclude from the exported file(s)
  ignoreCSS: ".tableexport-ignore", // (selector, selector[]), selector(s) to exclude cells from the exported file(s)
  emptyCSS: ".tableexport-empty", // (selector, selector[]), selector(s) to replace cells with an empty string in the exported file(s)
  trimWhitespace: false // (Boolean), remove all leading/trailing newlines, spaces, and tabs from cell text in the exported file(s)
});

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.

/* Run plugin and save it to a variable */
var tables = $("table").tableExport();

/* update */
tables.update({
  fileName: "newFile" // pass in a new set of properties
});

/* reset */
tables.reset(); // useful for a dynamically altered table

/* remove */
tables.remove(); // removes caption and buttons

Properties

Methods

Settings

Each button is assigned a default class and default content based on its respective filetype and corresponding css styles.

/* default class, content, and separator for each export type */

/* Excel Open XML spreadsheet (.xlsx) */
$.fn.tableExport.xlsx = {
  defaultClass: "xlsx",
  buttonContent: "Export to xlsx",
  mimeType: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  fileExtension: ".xlsx"
};

/* Excel Binary spreadsheet (.xls) */
$.fn.tableExport.xls = {
  defaultClass: "xls",
  buttonContent: "Export to xls",
  separator: "\t",
  mimeType: "application/vnd.ms-excel",
  fileExtension: ".xls"
};

/* Comma Separated Values (.csv) */
$.fn.tableExport.csv = {
  defaultClass: "csv",
  buttonContent: "Export to csv",
  separator: ",",
  mimeType: "application/csv",
  fileExtension: ".csv"
};

/* Plain Text (.txt) */
$.fn.tableExport.txt = {
  defaultClass: "txt",
  buttonContent: "Export to txt",
  separator: "  ",
  mimeType: "text/plain",
  fileExtension: ".txt"
};

Below are additional defaults to support the functionality of the plugin that.

/* default charset encoding (UTF-8) */
$.fn.tableExport.charset = "charset=utf-8";

/* default filename if "id" attribute is set and undefined */
$.fn.tableExport.defaultFileName = "myDownload";

/* default class to style buttons when not using bootstrap  */
$.fn.tableExport.defaultButton = "button-default";

/* bootstrap classes used to style and position the export buttons */
$.fn.tableExport.bootstrap = ["btn", "btn-default", "btn-toolbar"];

/* row delimeter used in all filetypes */
$.fn.tableExport.rowDel = "\r\n";

Browser Support

Chrome

Firefox

Opera

Safari *

Android

✓

iOS

✓

Mac OSX

✓

Windows

✓

Live Demo

Examples:

Customizing Properties

Customizing Settings

Miscellaneous

Skeletons

License

:star: Credits

Special thanks the the following contributors:

PreviousMigrating from 4.x to 5.x?Nextv4 docs

Last updated 4 years ago

Was this helpful?