docs: add setCustomFilter prop in docs

marmelab · Aug 30, 2022 · c42c9f1 · c42c9f1
1 parent 59f4b42
commit c42c9f1
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/docs/useList.md b/docs/useList.md
@@ -242,3 +242,21 @@ const {
     refetch, // a function that throws an error, as refetch doesn't make sense for local data
 } = getGetList({ data });
 ```
+## `setCustomFilter`
+
+Property for custom filter definition. Being able to apply more complex filters using operators
+
+```jsx
+const { data } = useList({
+    data: [
+        { id: 1, name: 'Arnold' },
+        { id: 2, name: 'Sylvester' },
+        { id: 3, name: 'Jean-Claude' },
+    ],
+    sort: { field: 'name', order: 'ASC' },
+    setCustomFilter: (record) => record.id > 1 && record.name !== 'Jean-Claude'
+});
+// data will be
+// [
+//    { id: 2, name: 'Sylvester' }, 
+// ]