6dcc69ee54
- This is a breaking backwards incompatible change - please be aware of this! - DataTables fires custom events such as `draw` etc, but these events were in no way identifyable as eminating from DataTables rather than some other component, which can cause confusion and difficulty resolving bugs. - As such, all DataTables events are now fired with the `dt` namespace - this means if you are currently using events, you must update your code to also use the .dt namespace. If you are already using namespaces, that's great, you can continue to do so as jQuery allows multiple namespaces, but you must still use the .dt namespace. - This is a breaking change because the old behaviour was incorrect - i.e. this was a bug to be fixed, hence why we haven't gone through a deprecation cycle. The old events weren't well documented (only in the JSDoc generated docs and a few of my forum posts), whereas in 1.10 they will form a key part of the documentation. As such, now is the time to get this right. This will be documented clearly in the upgrade notes. - Discussion on this topic here: https://github.com/DataTables/DataTables/issues/245
DataTables plug-in for jQuery
DataTables is a table enhancing plug-in for the jQuery Javascript library, adding sorting, paging and filtering abilities to plain HTML tables with minimal effort. The stated goal of DataTables is:
To enhance the accessibility of data in HTML tables.
To meet this goal, DataTables is developed with two distinct groups of users in mind:
-
You the developers using DataTables. For developers DataTables provides a wide array of options for how data should be obtained, displayed and acted upon, along with an extensive API for accessing and manipulating the table.
-
End users. For those using the interface DataTables presents, actions to get the most from the information contained in tables, such as sorting and filtering, along with paging and scrolling of the data in table, are easy to use, intuitive and fast.
Installation
In most cases, to use DataTables all you need to do is include jQuery, the DataTables Javascript and DataTables CSS files in your HTML page:
<link rel="stylesheet" type="text/css" href="//cdn.datatables.net/latest/jquery.dataTables.css">
<script type="text/javascript" language="javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
<script type="text/javascript" language="javascript" src="//cdn.datatables.net/1.10.0/jquery.dataTables.js"></script>
Usage
In its simplest case, DataTables can be initialised with a single line of Javascript:
$('table').dataTable();
where the jQuery selector is used to obtain a reference to the table you want to enhance with DataTables. Optional configuration parameters can be passed in to DataTables to have it perform certain actions by using a configuration object as the parameter passed in to the DataTables constructor. For example:
$('table').dataTable( {
paginate: false,
scrollY: 300
} );
will disable paging and enable scrolling.
A full list of the options available for DataTables are available in the documentation.
Documentation
Full documentation of the DataTables options, API and pug-in interface are available on the DataTables web-site. The site also contains information on the wide variety of plug-ins that are available for DataTables, which can be used to enhance and customise your table even further.
Support
Support for DataTables is available through the DataTables forums and commercial support options are available.
License
DataTables is release under the MIT license. You are free to use, modify and distribute this software, as long as the copyright header is left intact (specifically the comment block which starts with /*!.