Skip to content

Commit 2b37f49

Browse files
committed
fix: v6 docs update
1 parent e9e7b69 commit 2b37f49

File tree

8 files changed

+11
-18
lines changed

8 files changed

+11
-18
lines changed

docs/config/pagination.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ To enable the pagination plugin
1515

1616
| Name | Description | Type |
1717
|------------------------------|-----------------------------------------------|---------------|
18-
| enabled | to enable/disable pagination | boolean |
1918
| limit `optional` | rows per page | number |
2019
| page `optional` | initial page | number |
2120
| summary `optional` | to show/hide the pagination summary | boolean |
@@ -36,7 +35,6 @@ new Grid({
3635
['Nisen', '[email protected]', '313 333 1923']
3736
],
3837
pagination: {
39-
enabled: true,
4038
limit: 2,
4139
summary: false
4240
}

docs/config/search.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ To enable or disable the global search plugin
1515

1616
| Name | Description | Type | Example |
1717
|----------------------------|--------------------------------|----------|---------------------|
18-
| enabled | to enable/disable the plugin | boolean | `true` or `false` |
1918
| keyword `optional` | to initiate with a keyword | string | `John` |
2019
| server `optional` | to enable server integration | object | [Server-side search](../examples/server-side-search.md) |
2120
| debounceTimeout `optional` | search debounce timout | number | `1000` (1 second) |
@@ -32,9 +31,7 @@ new Grid({
3231
['Eoin', '[email protected]', '(05) 10 878 5554'],
3332
['Nisen', '[email protected]', '313 333 1923']
3433
],
35-
search: {
36-
enabled: true
37-
}
34+
search: true
3835
});
3936
```
4037

docs/config/sort.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ To enable the sorting plugin. Sort has two config objects:
2020

2121
| Name | Description | Type |
2222
|-------------------------|-------------------------------------|---------------|
23-
| enabled | to enable/disable sorting | boolean |
2423
| multiColumn `optional` | Enable/disable multi column sort | boolean |
2524
| server `optional` | Server-side integration | ServerConfig |
2625

@@ -69,7 +68,6 @@ new Grid({
6968

7069
| Name | Description | Type |
7170
|-------------------------|-------------------------------------|--------------------|
72-
| enabled | to enable/disable sorting | boolean |
7371
| compare `optional` | custom comparator function | `Comparator<TCell>`|
7472

7573
</div>
@@ -83,9 +81,7 @@ new Grid({
8381
'Email',
8482
{
8583
name: 'Phone Number',
86-
sort: {
87-
enabled: false
88-
}
84+
sort: false
8985
}
9086
],
9187
sort: true,

docs/examples/custom-sort.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,7 @@ const grid = new Grid({
5151
});
5252
`
5353
} />
54+
55+
:::tip
56+
In the example above, we are sorting the "Phone Number" column based on the _last 4 digits_!
57+
:::

docs/examples/server-side-pagination.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ is correctly defined in the main `server` config block:
2121
const grid = new Grid({
2222
columns: ['Pokemon', 'URL'],
2323
pagination: {
24-
enabled: true,
2524
limit: 5,
2625
server: {
2726
url: (prev, page, limit) => \`\${prev}?limit=\${limit}&offset=\${page * limit}\`

docs/integrations/react.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ import { Grid } from 'gridjs-react';
3333
columns={['Name', 'Email']}
3434
search={true}
3535
pagination={{
36-
enabled: true,
3736
limit: 1,
3837
}}
3938
/>

package-lock.json

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"chartist": "^0.11.4",
1919
"classnames": "^2.3.1",
2020
"faker": "^5.5.3",
21-
"gridjs": "^6.0.4",
21+
"gridjs": "^6.0.5",
2222
"gridjs-react": "^6.0.1",
2323
"postcss-scss": "^3.0.5",
2424
"react": "^17.0.2",

0 commit comments

Comments
 (0)