Skip to content

Commit c733ea5

Browse files
committed
update doc
1 parent 32c0e3e commit c733ea5

File tree

4 files changed

+36
-15
lines changed

4 files changed

+36
-15
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
# vue-datatables-net
2-
> Vue jQuery DataTable.net component
2+
> Vue jQuery DataTable.net wrapper component
33
4-
This library is simply a wrapper for [jQuery DataTable](https://datatables.net/). It's a tiny package that doesn't include anything, not even the datatable.net core library. Per example below, you basically have to include any/only datatable.net package(s) that you need.
4+
This library is simply a wrapper for [jQuery DataTable](https://datatables.net/). It's a tiny package that doesn't include anything, not even the datatable.net core library. Per example below, you basically have to include only/any datatable.net package(s) that you need.
5+
6+
The initial focus/design of this library is to use with ajax/server-side endpoint. For local data, simply use native methods like so:
7+
8+
```javascript
9+
component.dataTable.clear().draw();
10+
component.dataTable.rows.add(newDataArray).draw();
11+
```
512

613
## Usage
714
Like our example App, which demonstrate how to pass in overrides for our [jQuery DataTable](https://datatables.net/manual/options) default options - https://github.com/niiknow/vue-datatables-net/blob/master/example/App.vue#L8
@@ -44,4 +51,19 @@ Since it's a wrapper, all/most features are provided by the [jQuery DataTable](h
4451

4552
More documentation for this library, to come.
4653

54+
## Additional Headers
55+
Since options are completely exposed, simply use the native method per [jQuery DataTable example](https://editor.datatables.net/manual/security#Prevention)
56+
57+
Or something like:
58+
```javascript
59+
options: {
60+
'ajax': {
61+
'url': url,
62+
'type': 'GET',
63+
'beforeSend': function (request) {
64+
request.setRequestHeader("token", token);
65+
}
66+
}
67+
}
68+
```
4769
# MIT

example/App.vue

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,16 @@ export default {
4343
// console.log(json)
4444
return json
4545
}
46-
}
46+
},
47+
processing: true,
48+
pageLength: 10,
49+
searching: true,
50+
searchDelay: 1500,
51+
destroy: true,
52+
ordering: true,
53+
lengthChange: true,
54+
serverSide: true,
55+
fixedHeader: true
4756
},
4857
fields: {
4958
id: { label: 'ID', sortable: true },

lib/vue-datatables-net.min.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/VdtnetTable.vue

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -52,21 +52,11 @@ export default {
5252
// initialize defaults
5353
return {
5454
options: {
55-
processing: true,
56-
pageLength: 15,
57-
searching: true,
58-
searchDelay: 1500,
59-
destroy: true,
60-
ordering: true,
61-
lengthChange: true,
62-
serverSide: true,
63-
ajax: '',
64-
fixedHeader: true,
6555
dom: '<\'row\'<\'col-sm-12 col-md-4\'l><\'text-right col-sm-12 col-md-6\'B><\'col-sm-12 col-md-2\'f>>' +
6656
'<\'row\'<\'col-sm-12\'tr>>' +
6757
'<\'row\'<\'col-sm-12 col-md-5\'i><\'col-sm-12 col-md-7\'p>>',
6858
columns: [],
69-
buttons: []
59+
buttons: [] // remove any button defaults
7060
},
7161
dataTable: null
7262
}

0 commit comments

Comments
 (0)