jQuery Support

• Overview
  • Install
  • Documentation Changes

Overview

Tabulator comes with a jQuery wrapper so that you can use it easily in any jQuery based project.

Install

If you want to instantiate Tabulator as a jQuery widget you will need to include the jquery wrapper file after your tabulator js file

<script type="text/javascript" src="dist/js/tabulator.min.js"></script>
<script type="text/javascript" src="dist/js/jquery_wrapper.js"></script>

Documentation Changes

The documentation on this site uses vanilla JS in the examples, so to use it with jQuery you will need to slightly tweak the approach used in the examples.

Table Definition

Anywhere it shows instantiating a table using the Tabulator constructor:

var table = new Tabulator("#example-table", {
  //table setup options
});

You can use a jquery selector with widget:

$("#example-table").tabulator({
  //table setup options
});

Function Calls

Anywhere you see a function being called

table.getRow(1);

You can use the jQuery widget approach

$("#example-table").tabulator("getRow", 1);