mirror of https://github.com/DataTables/DataTables.git synced 2024-11-29 11:24:10 +01:00

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. https://datatables.net/

Go to file

Allan Jardine 79f969ef58 Fix: `dt-api $.fn.dataTable.isDataTable()` could give incorrect results if a table did not have scrolling enabled		2015-03-18 16:53:25 +00:00
examples	New: `dt-api rows().every()`, `dt-api columns().every()` and `dt-api cells().every()` iterator methods to make it easier to perform operations on the table elements. This is done by setting the context of the callback provided to be the singular expression for the table elemtn in question. This basically means you can access the singular methods from `this` - e.g. `this.data()` will get the data for the element, `this.node()` will get the cell when using `dt-api cells().every()` etc. The exisiting interator methods of `dt-api each()` and `dt-api iterator()` remain, and each has its own place for optimial usage of the API, but it is likely that the majority of use will switch to focus on these new methods. The examples in the rest of hte documentation has been updated to reflect this fact.	2015-03-03 15:42:36 +00:00
media	Fix: `dt-api $.fn.dataTable.isDataTable()` could give incorrect results if a table did not have scrolling enabled	2015-03-18 16:53:25 +00:00
.datatables-commit-sync	Fix: `dt-api $.fn.dataTable.isDataTable()` could give incorrect results if a table did not have scrolling enabled	2015-03-18 16:53:25 +00:00
.gitignore	Add minified files to built repo	2014-06-23 15:40:22 +01:00
bower.json	Dev: Firebase database in example documentation rather than AIR (outdated)	2015-02-12 14:10:38 +00:00
composer.json	Dev: Firebase database in example documentation rather than AIR (outdated)	2015-02-12 14:10:38 +00:00
Contributing.md	Dev: Update contributing document to add note about contributions being under the MIT license (explicit concent required) and to acknowledge that DataTables is a large and complex project, so not all PRs can always be accepted.	2015-03-03 21:57:51 +00:00
dataTables.jquery.json	Dev: Firebase database in example documentation rather than AIR (outdated)	2015-02-12 14:10:38 +00:00
license.txt	Licensing: DataTables is now available under the MIT license	2013-12-11 17:24:30 +00:00
package.json	Dev: Fix CSS as a dependency	2015-02-16 16:01:14 +00:00
Readme.md	Fix: #384 . Direct to the manual page for latest install instructions	2014-07-30 10:16:47 +01:00

Readme.md

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. See the DataTables manual for details on how to do this using the latest version of DataTables.

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 /*!.