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 b956a69271 Fix - API: Errors in plurals and signular forms of method naming		2013-11-13 16:22:04 +00:00
examples	Updated: Update examples and documentation for the change in committed	2013-11-12 19:18:51 +00:00
media	Fix - API: Errors in plurals and signular forms of method naming	2013-11-13 16:22:04 +00:00
.datatables-commit-sync	Fix - API: Errors in plurals and signular forms of method naming	2013-11-13 16:22:04 +00:00
.gitignore	Dev: Ignore the Plugins repo	2012-06-22 08:18:53 +01:00
bower.json	Dev fix: Fix dependency for bower	2013-07-25 22:19:41 +01:00
composer.json	Packaging: Change composer.json descrptor name to use lower case	2013-10-17 10:56:50 +01:00
Contributing.md	Add contributing file and update readme to be a markdown file with	2013-10-16 14:24:42 +01:00
dataTables.jquery.json	Build: Package desciptors now held in a common location and built as	2013-07-21 09:10:37 +01:00
license-bsd.txt	Initial commit - DataTables 1.7.0	2010-08-17 08:42:13 +01:00
license-gpl2.txt	Initial commit - DataTables 1.7.0	2010-08-17 08:42:13 +01:00
package.json	Build: Package desciptors now held in a common location and built as	2013-07-21 09:10:37 +01:00
Readme.md	Update readme license text to be clear what copyright information must remain	2013-10-24 13:19:16 +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:

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