Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details

All Projects → clarketm → Tableexport

clarketm / Tableexport

Licence: apache-2.0

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

Programming Languages

javascript

184084 projects - #8 most used programming language

Labels

bootstrap jquery flask demo csv jquery-plugin excel localstorage xlsx export xls requirejs

Projects that are alternatives of or similar to Tableexport

dbd

dbd is a database prototyping tool that enables data analysts and engineers to quickly load and transform data in SQL databases.

Stars: ✭ 30 (-96.16%)

Mutual labels: csv, excel, xlsx, xls

exoffice

Library to parse common excel formats (xls, xlsx, csv)

Stars: ✭ 31 (-96.03%)

Mutual labels: csv, excel, xlsx, xls

❌ Multi-format spreadsheet CLI (now merged in http://github.com/sheetjs/js-xlsx )

Stars: ✭ 343 (-56.08%)

Mutual labels: excel, csv, xlsx, xls

Pyexcel

Single API for reading, manipulating and writing data in csv, ods, xls, xlsx and xlsm files

Stars: ✭ 902 (+15.49%)

Mutual labels: excel, csv, xlsx, xls

spreadsheet

Yii2 extension for export to Excel

Stars: ✭ 79 (-89.88%)

Mutual labels: export, excel, xlsx, xls

Rows

A common, beautiful interface to tabular data, no matter the format

Stars: ✭ 739 (-5.38%)

Mutual labels: excel, csv, xlsx, xls

Npoi.mapper

Use this tool to import or export data with Excel file. The tool is a convention based mapper between strong typed object and Excel data via NPOI.

Stars: ✭ 348 (-55.44%)

Mutual labels: excel, xlsx, xls, export

Myexcel

MyExcel, a new way to operate excel!

Stars: ✭ 1,198 (+53.39%)

Mutual labels: excel, csv, xlsx, xls

eec

A fast and lower memory excel write/read tool.一个非POI底层，支持流式处理的高效且超低内存的Excel读写工具

Stars: ✭ 93 (-88.09%)

Mutual labels: csv, excel, xlsx, xls

sheet2dict

Simple XLSX and CSV to dictionary converter

Stars: ✭ 206 (-73.62%)

Mutual labels: export, csv, excel, xlsx

Sheetjs

📗 SheetJS Community Edition -- Spreadsheet Data Toolkit

Stars: ✭ 28,479 (+3546.48%)

Mutual labels: excel, csv, xlsx, xls

swiss-army knife for data

Stars: ✭ 275 (-64.79%)

Mutual labels: excel, csv, xlsx

Jquery Smartwizard

The awesome jQuery step wizard plugin

Stars: ✭ 635 (-18.69%)

Mutual labels: jquery-plugin, bootstrap, jquery

workbook

simple framework for containing spreadsheet like data

Stars: ✭ 13 (-98.34%)

Mutual labels: csv, xlsx, xls

Exporttools.bundle

Export tools for Plex

Stars: ✭ 294 (-62.36%)

Mutual labels: csv, xlsx, export

Easyexcel

快速、简单避免OOM的java处理Excel工具

Stars: ✭ 22,133 (+2733.93%)

Mutual labels: excel, xlsx, xls

Exporter

Lightweight Exporter library

Stars: ✭ 384 (-50.83%)

Mutual labels: csv, xls, export

Meza

A Python toolkit for processing tabular data

Stars: ✭ 374 (-52.11%)

Mutual labels: excel, csv, xlsx

Bootstrap Submenu

Bootstrap sub-menus

Stars: ✭ 442 (-43.41%)

Mutual labels: jquery-plugin, bootstrap, jquery

Bootstrap Fileinput

An enhanced HTML 5 file input for Bootstrap 5.x/4.x./3.x with file preview, multiple selection, and more features.

Stars: ✭ 5,097 (+552.62%)

Mutual labels: jquery-plugin, bootstrap, jquery

View All Similar Projects ➔

Docs

Getting Started

Install manually using `<script>` tags

To use this library, include the FileSaver.js library, and TableExport library before the closing <body> tag of your HTML document:

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

Install with Bower

$ bower install tableexport.js

Install with npm

$ npm install tableexport

CDN

unpkg

	uncompressed	compressed
CSS	🔗	🔗
JS	🔗	🔗
Images	—	🔗^xlsx 🔗^xls 🔗^csv 🔗^txt

Dependencies

Required:

FileSaver.js

Optional:

jQuery (1.2.1 or higher)
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 library in your project before both FileSaver.js and TableExport.

xlsx.core.js by SheetJS

Including xlsx.core.js is NOT necessary if installing with Bower or npm

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

Older Browsers:

To support legacy browsers ( Chrome < 20, Firefox < 13, Opera < 12.10, IE < 10, Safari < 6 ) include the Blob.js polyfill before the FileSaver.js script.

Blob.js by eligrey (forked by clarketm)

Including Blob.js is NOT necessary if installing with Bower or npm

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

Usage

JavaScript

To use this library, simple call the TableExport constructor:

new TableExport(document.getElementsByTagName("table"));

// OR simply

TableExport(document.getElementsByTagName("table"));

// OR using jQuery

$("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 filetype(s) of your choice.

/* Defaults */
TableExport(document.getElementsByTagName("table"), {
  headers: true,                      // (Boolean), display table headers (th or td elements) in the <thead>, (default: true)
  footers: true,                      // (Boolean), display table footers (th or td elements) in the <tfoot>, (default: false)
  formats: ["xlsx", "csv", "txt"],    // (String[]), filetype(s) for the export, (default: ['xlsx', 'csv', 'txt'])
  filename: "id",                     // (id, String), filename for the downloaded file, (default: 'id')
  bootstrap: false,                   // (Boolean), style buttons using bootstrap, (default: true)
  exportButtons: true,                // (Boolean), automatically generate the built-in export buttons for each of the specified formats (default: true)
  position: "bottom",                 // (top, bottom), position of the caption element relative to table, (default: 'bottom')
  ignoreRows: null,                   // (Number, Number[]), row indices to exclude from the exported file(s) (default: null)
  ignoreCols: null,                   // (Number, Number[]), column indices to exclude from the exported file(s) (default: null)
  trimWhitespace: true,               // (Boolean), remove all leading/trailing newlines, spaces, and tabs from cell text in the exported file(s) (default: false)
  RTL: false,                         // (Boolean), set direction of the worksheet to right-to-left (default: false)
  sheetname: "id"                     // (id, String), sheet name for the exported spreadsheet, (default: 'id')
});

Note: to use the xlsx filetype, you must include Add-Ons section.

Properties

Methods

TableExport supports additional methods (getExportData, update, reset and remove) to control the TableExport instance after creation.

/* First, call the `TableExport` constructor and save the return instance to a variable */
var table = TableExport(document.getElementById("export-buttons-table"));

`getExportData`

/* get export data */
var exportData = table.getExportData(); // useful for creating custom export buttons, i.e. when (exportButtons: false)

/*****************
 ** exportData ***
 *****************
{
    "export-buttons-table": {
        xls: {
            data: "...",
            fileExtension: ".xls",
            filename: "export-buttons-table",
            mimeType: "application/vnd.ms-excel"
        },
        ...
    }
};
*/

`export2file`

/* convert export data to a file for download */
var exportData = table.getExportData(); 
var xlsxData = exportData.table.xlsx; // Replace with the kind of file you want from the exportData
table.export2file(xlsxData.data, xlsxData.mimeType, xlsxData.filename, xlsxData.fileExtension, xlsxData.merges, xlsxData.RTL, xlsxData.sheetname)

`getFileSize`

var tableId = "export-buttons-table";
var XLS = table.CONSTANTS.FORMAT.XLS;

/* get export data (see `getExportData` above) */
var exportDataXLS = table.getExportData()[tableId][XLS];

/* get file size (bytes) */
var bytesXLS = table.getFileSize(exportDataXLS.data, exportDataXLS.fileExtension);

/**********************************
 ** bytesXLS (file size in bytes)
 **********************************
352
*/

`update`

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

`reset`

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

`remove`

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

Settings

Below are some of the popular configurable settings to customize the functionality of the library.

`ignoreCSS`

/**
 * CSS selector or selector[] to exclude/remove cells (<td> or <th>) from the exported file(s).
 * @type {selector|selector[]}
 * @memberof TableExport.prototype
 */

// selector
TableExport.prototype.ignoreCSS = ".tableexport-ignore";

// selector[]
TableExport.prototype.ignoreCSS = [".tableexport-ignore", ".other-ignore-class"];

// OR using jQuery

// selector
$.fn.tableExport.ignoreCSS = ".tableexport-ignore";

// selector[]
$.fn.tableExport.ignoreCSS = [".tableexport-ignore", ".other-ignore-class"];

`emptyCSS`

/**
 * CSS selector or selector[] to replace cells (<td> or <th>) with an empty string in the exported file(s).
 * @type {selector|selector[]}
 * @memberof TableExport.prototype
 */

// selector
TableExport.prototype.emptyCSS = ".tableexport-empty";

// selector[]
TableExport.prototype.emptyCSS = [".tableexport-empty", ".other-empty-class"];

// OR using jQuery

// selector
$.fn.tableExport.emptyCSS = ".tableexport-empty";

// selector[]
$.fn.tableExport.emptyCSS = [".tableexport-empty", ".other-empty-class"];

/* default charset encoding (UTF-8) */
TableExport.prototype.charset = "charset=utf-8";

/* default `filename` property if "id" attribute is unset */
TableExport.prototype.defaultFilename = "myDownload";

/* default class to style buttons when not using Bootstrap or the built-in export buttons, i.e. when (`bootstrap: false` & `exportButtons: true`)  */
TableExport.prototype.defaultButton = "button-default";

/* Bootstrap classes used to style and position the export button, i.e. when (`bootstrap: true` & `exportButtons: true`) */
TableExport.prototype.bootstrapConfig = ["btn", "btn-default", "btn-toolbar"];

/* row delimeter used in all filetypes */
TableExport.prototype.rowDel = "\r\n";

/**
 * Format-specific configuration (default class, content, mimeType, etc.)
 * @memberof TableExport.prototype
 */
formatConfig: {
    /**
     * XLSX (Open XML spreadsheet) file extension configuration
     * @memberof TableExport.prototype
     */
    xlsx: {
        defaultClass: 'xlsx',
        buttonContent: 'Export to xlsx',
        mimeType: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
        fileExtension: '.xlsx'
    },
    xlsm: {
        defaultClass: 'xlsm',
        buttonContent: 'Export to xlsm',
        mimeType: 'application/vnd.ms-excel.sheet.macroEnabled.main+xml',
        fileExtension: '.xlsm'
    },
    xlsb: {
        defaultClass: 'xlsb',
        buttonContent: 'Export to xlsb',
        mimeType: 'application/vnd.ms-excel.sheet.binary.macroEnabled.main',
        fileExtension: '.xlsb'
    },
    /**
     * XLS (Binary spreadsheet) file extension configuration
     * @memberof TableExport.prototype
     */
    xls: {
        defaultClass: 'xls',
        buttonContent: 'Export to xls',
        separator: '\t',
        mimeType: 'application/vnd.ms-excel',
        fileExtension: '.xls',
        enforceStrictRFC4180: false
    },
    /**
     * CSV (Comma Separated Values) file extension configuration
     * @memberof TableExport.prototype
     */
    csv: {
        defaultClass: 'csv',
        buttonContent: 'Export to csv',
        separator: ',',
        mimeType: 'text/csv',
        fileExtension: '.csv',
        enforceStrictRFC4180: true
    },
    /**
     * TXT (Plain Text) file extension configuration
     * @memberof TableExport.prototype
     */
    txt: {
        defaultClass: 'txt',
        buttonContent: 'Export to txt',
        separator: '  ',
        mimeType: 'text/plain',
        fileExtension: '.txt',
        enforceStrictRFC4180: true
    }
},

//////////////////////////////////////////
// Configuration override example
//////////////////////////////////////////

/* Change the CSV (Comma Separated Values) `mimeType` to "application/csv" */
TableExport.prototype.formatConfig.xlsx.mimeType = "application/csv"

CSS

TableExport packages with customized Bootstrap CSS stylesheets to deliver enhanced table and button styling. These styles can be enabled by initializing with the bootstrap property set to true.

TableExport(document.getElementsByTagName("table"), {
  bootstrap: true
});

When used alongside Bootstrap, there are four custom classes .xlsx, .xls, .csv, .txt providing button styling for each of the exportable filetypes.

Browser Support

	Chrome	Firefox	IE	Opera	Safari
Android	✓	✓	-	✓	-
iOS	✓	-	-	-	✓
Mac OSX	✓	✓	-	✓	✓
Windows	✓	✓	✓	✓	✓

A full list of browser support can be found in the FileSaver.js README. Some legacy browsers may require an additional third-party dependency: Blob.js

Examples

Customizing Properties

Customizing Settings

Miscellaneous

rowspan
colspan
cell data types (string, number, boolean, date)
emoji
Arabic

Skeletons

TableExport + RequireJS skeleton.
TableExport + Flask skeleton.
TableExport + Webpack 1 skeleton.
TableExport + Angular 4 + Webpack 2 skeleton.

License

TableExport is licensed under the terms of the Apache-2.0 License

Going Forward

TODOs

[x] Update JSDocs and TypScript definition file.
[x] Fix bug with CSV and TXT ignoreRows and ignoreCols (rows/cols rendered as empty strings rather than being removed).
[x] Reimplement and test the update, reset, and remove TableExport prototype properties without requiring jQuery.
[x] Make jQuery as peer dependency and ensure proper TableExport rendering in browser, AMD, and CommonJS environments.
[x] Force jQuery to be an optionally loaded module.
[x] Use the enhanced SheetJS xls, csv, and txt formats (exposed via enforceStrictRFC4180 prototype property).
[x] Allow ignoreCSS and emptyCSS to work with any selector|selector[] instead of solely a single CSS class.
[x] Ensure (via testing) full consistency and backwards-compatibility for jQuery.
[ ] Add Export as PDF support.

Credits

Special thanks the the following contributors:

SheetJS - js-xlsx
Eli Grey - FileSaver.js & Blob.js

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].

Stars: ✭ 781

Visit Git Page 🔗Visit User Page 🔗Visit Issues Page (105) 🔗

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

clarketm / Tableexport

Programming Languages

Labels

Projects that are alternatives of or similar to Tableexport

Docs

Getting Started

Install manually using <script> tags

Install with Bower

Install with npm

CDN

Dependencies

Required:

Optional:

Add-Ons:

Older Browsers:

Usage

JavaScript

Properties

Methods

Settings

CSS

Browser Support

Examples

Customizing Properties

Customizing Settings

Miscellaneous

Skeletons

License

Going Forward

TODOs

Credits

Install manually using `<script>` tags