Skip to content

Commit da30eab

Browse files
authored
Merge pull request #8404 from marmelab/fix-uselist-doc
[Doc] Improve `useList`'s `filterCallback` prop description
2 parents 9b2349d + 2629227 commit da30eab

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/useList.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ The `useGetList` parameter accepts the following options:
7070
* [`page`](#page)
7171
* [`perPage`](#perpage)
7272
* [`sort`](#sort)
73+
* [`filterCallback`](#filtercallback)
7374

7475
## `filter`
7576

@@ -242,9 +243,10 @@ const {
242243
refetch, // a function that throws an error, as refetch doesn't make sense for local data
243244
} = getGetList({ data });
244245
```
246+
245247
## `filterCallback`
246248

247-
Property for custom filter definition. Being able to apply more complex filters using operators
249+
Property for custom filter definition. Lets you apply local filters to the fetched data.
248250

249251
```jsx
250252
const { data } = useList({
@@ -259,4 +261,5 @@ const { data } = useList({
259261
// data will be
260262
// [
261263
// { id: 2, name: 'Sylvester' },
262-
// ]
264+
// ]
265+
```

0 commit comments

Comments
 (0)