Skip to content

Commit 73644de

Browse files
committed
chore: readme
1 parent 22f7b70 commit 73644de

File tree

3 files changed

+87
-10644
lines changed

3 files changed

+87
-10644
lines changed

README.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,40 @@
1-
# gridjs-jquery
2-
Grid.js jQuery integration
1+
# Grid.js jQuery
2+
3+
JQuery wrapper for [Grid.js](https://gridjs.io/)
4+
5+
## Install
6+
7+
```bash
8+
npm install --save gridjs-jquery
9+
```
10+
11+
**Note**: `gridjs-jquery` contains Grid.js package as well. You don't need to install it separately.
12+
13+
## Usage
14+
15+
Select your wrapper and call `Grid`:
16+
17+
```js
18+
$("div#wrapper").Grid({
19+
columns: ['Name', 'Age', 'Email'],
20+
data: [
21+
['John', 25, '[email protected]'],
22+
['Mark', 59, '[email protected]'],
23+
// ...
24+
],
25+
});
26+
```
27+
28+
Grid.js can also convert an HTML table. Simply select the table with jQuery
29+
and call `Grid`:
30+
31+
```js
32+
$("table#myTable").Grid();
33+
```
34+
35+
You can pass all Grid.js configs to the `Grid` function.
36+
See [Grid.js Config](https://gridjs.io/docs/config) for more details.
37+
38+
## License
39+
40+
MIT

0 commit comments

Comments
 (0)