Skip to content

Commit 2f9c5c6

Browse files
committed
chore: readme
1 parent 9ff11d9 commit 2f9c5c6

File tree

1 file changed

+38
-2
lines changed

1 file changed

+38
-2
lines changed

README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,38 @@
1-
# gridjs-react
2-
Grid.js component for React
1+
# Grid.js for React
2+
3+
[Grid.js](https://gridjs.io/) component for React
4+
5+
## Install
6+
7+
```bash
8+
npm install --save gridjs-react
9+
```
10+
11+
Also, make sure you have Grid.js installed already as it's a peer dependency of `gridjs-react`:
12+
13+
```bash
14+
npm install --save gridjs
15+
```
16+
17+
## Usage
18+
19+
```jsx
20+
<Grid
21+
data={data: [
22+
['John', '[email protected]'],
23+
['Mike', '[email protected]']
24+
]}
25+
columns={['Name', 'Email']}
26+
search={true}
27+
pagination={{
28+
enabled: true,
29+
limit: 1,
30+
}}
31+
/>
32+
```
33+
34+
Then you can pass all Grid.js configs to the `Grid` component. See [Grid.js Config](https://gridjs.io/docs/config) for more details.
35+
36+
## License
37+
38+
MIT

0 commit comments

Comments
 (0)