@sanders.king/r-table
v1.1.8
Published
A faster alternative to DataTables
Downloads
11
Readme
r-table
r-table is a JavaScript tool to create HTML tables from an array of data objects and an array of column definitions. It provides searching, sorting, and grouping functionality.
r-table can display millions of rows, without paging, with minimal loss of performance. An initial render of 3 million rows is likely to take less than a second.
Credit to DataTables
r-table was inspired by DataTables. r-table is a faster replacement for DataTables when displaying thousands or millions of rows (without paging). r-table provides a simple implementation of the DataTables render interface.
r-table does not implement the advanced functionality or extensibility of DataTables. The author of r-table gives all credit to DataTables for being a brilliant product.
Internet Explorer 11 - ES5
r-table is ES5 compatible as it was written for an embedded IE11 target environment.
Installation
r-table is installed using the NPM package manager: npm install @sanders.king/r-table
Usage
The JavaScript file r-table/dist/js/rtable-bundle.js must be included in a script tag in your HTML file, or included via a require("") statement. The CSS file r-table/dist/css/r-table.css bundle must be linked in your HTML file. The CSS file r-table/dist/css/font-awesome.css bundle must be linked in your HTML file.
Use RTable.tools to create a collection of columns:
...
column = RTable.tools.createColumn("Name", "name", "string");
column.groupable = true;
columns.push(column);
column = RTable.tools.createColumn("Birth date", "DOB", "date");
columns.push(column);
column = RTable.tools.createColumn("Special", "special", "string", null, null, null, specialColumnRenderFunction);
columns.push(column);
...
Use RTable.init to append an r-table to a target element:
var options = {};
options.selectMode = "single";
options.drawRowCount = 40;
var rTable = RTable.init($("#rtable"), columns, rows, options, function (event) {
console.log(event.event);
if (event.event === "row-select" || event.event === "row-deselect") {
...
}
});
Refer to r-table/html/test_rtable.html for an example.
Detailed usage documentation
Unfortunately detailed documentation is not yet available. I will clean up the code and provide proper documentation if it seems to become necessary. Contact me at [email protected].