datatables.net 2.2.1 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/Readme.md CHANGED
@@ -1,6 +1,6 @@
1
- # DataTables for jQuery
1
+ # DataTables
2
2
 
3
- This package contains distribution files for the [DataTables library](https://datatables.net) for [jQuery](http://jquery.com/). Only the core software for this library is contained in this package - to be correctly styled, a styling package for DataTables must also be included. Styling options include DataTable's native styling, [Bootstrap](http://getbootstrap.com) and [Foundation](http://foundation.zurb.com/).
3
+ This package contains distribution files for the [DataTables table enhancement library](https://datatables.net). Only the core software for this library is contained in this package - to be correctly styled, a styling package for DataTables must also be included (e.g. default, Bootstrap, Bulma, Foundation or others) - please see the [npm installation documentation on the DataTables site](https://datatables.net/manual/installation#Node.js-/-NPM) for full details.
4
4
 
5
5
  DataTables is a table enhancing library which adds features such as paging, ordering, search, scrolling and many more to a static HTML page. A comprehensive API is also available that can be used to manipulate the table. Please refer to the [DataTables web-site](//datatables.net) for a full range of documentation and examples.
6
6
 
@@ -9,29 +9,34 @@ DataTables is a table enhancing library which adds features such as paging, orde
9
9
 
10
10
  ### Browser
11
11
 
12
- For inclusion of this library using a standard `<script>` tag, rather than using this package, it is recommended that you use the [DataTables download builder](//datatables.net/download) which can create CDN or locally hosted packages \for you, will all dependencies satisfied.
12
+ To use DataTables with a simple `<script>` tag, rather than using this package, it is recommended that you use the [DataTables download builder](//datatables.net/download) which can create CDN or locally hosted packages for you, will all dependencies satisfied.
13
13
 
14
14
  ### npm
15
15
 
16
+ For installation via npm, yarn and other similar package managers, install this package with your package manager - e.g.:
17
+
16
18
  ```
17
19
  npm install datatables.net
18
20
  ```
19
21
 
20
- ES3 Syntax
21
- ```
22
- var $ = require( 'jquery' );
23
- require( 'datatables.net' )( window, $ );
24
- ```
22
+ Then, to load and initialise DataTables in your code use:
25
23
 
26
- ES6 Syntax
27
24
  ```
28
- import 'datatables.net'
25
+ import DataTable from 'datatables.net';
26
+
27
+ new DataTable('#myTable', {
28
+ // initialisation options
29
+ });
29
30
  ```
30
31
 
31
- ### bower
32
+ If you are using an old version of Node or a CommonJS loader, you might need to use the `require` syntax:
32
33
 
33
34
  ```
34
- bower install --save datatables.net
35
+ const DataTable = require('datatables.net');
36
+
37
+ new DataTable('#myTable', {
38
+ // initialisation options
39
+ });
35
40
  ```
36
41
 
37
42
 
@@ -45,7 +50,6 @@ Full documentation of the DataTables options, API and plug-in interface are avai
45
50
 
46
51
  Support for DataTables is available through the [DataTables forums](//datatables.net/forums) and [commercial support options](//datatables.net/support) are available.
47
52
 
48
-
49
53
  ### Contributing
50
54
 
51
55
  If you are thinking of contributing code to DataTables, first of all, thank you! All fixes, patches and enhancements to DataTables are very warmly welcomed. This repository is a distribution repo, so patches and issues sent to this repo will not be accepted. Instead, please direct pull requests to the [DataTables/DataTablesSrc](http://github.com/DataTables/DataTablesSrc). For issues / bugs, please direct your questions to the [DataTables forums](//datatables.net/forums).