feat: rename prop to filterCallback

marmelab · Aug 31, 2022 · ce15352 · ce15352
1 parent c42c9f1
commit ce15352
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/docs/useList.md b/docs/useList.md
@@ -242,7 +242,7 @@ const {
     refetch, // a function that throws an error, as refetch doesn't make sense for local data
 } = getGetList({ data });
 ```
-## `setCustomFilter`
+## `filterCallback`
 
 Property for custom filter definition. Being able to apply more complex filters using operators
 
@@ -254,7 +254,7 @@ const { data } = useList({
         { id: 3, name: 'Jean-Claude' },
     ],
     sort: { field: 'name', order: 'ASC' },
-    setCustomFilter: (record) => record.id > 1 && record.name !== 'Jean-Claude'
+    filterCallback: (record) => record.id > 1 && record.name !== 'Jean-Claude'
 });
 // data will be
 // [

diff --git a/packages/ra-core/src/controller/list/useList.spec.tsx b/packages/ra-core/src/controller/list/useList.spec.tsx
@@ -242,7 +242,7 @@ describe('<useList />', () => {
             <UseList
                 data={data}
                 sort={{ field: 'id', order: 'ASC' }}
-                setCustomFilter={record => record.id > 2}
+                filterCallback={record => record.id > 2}
                 callback={callback}
             />
         );

diff --git a/packages/ra-core/src/controller/list/useList.ts b/packages/ra-core/src/controller/list/useList.ts
@@ -48,7 +48,7 @@ const refetch = () => {
  * @param {Number} props.page: Optional. The initial page index
  * @param {Number} props.perPage: Optional. The initial page size
  * @param {SortPayload} props.sort: Optional. The initial sort (field and order)
- * @param {setCustomFilter} prop.setCustomFilter Optional. A function that allows you to make a custom filter
+ * @param {filterCallback} prop.filterCallback Optional. A function that allows you to make a custom filter
  */
 export const useList = <RecordType extends RaRecord = any>(
     props: UseListOptions<RecordType>
@@ -62,7 +62,7 @@ export const useList = <RecordType extends RaRecord = any>(
         page: initialPage = 1,
         perPage: initialPerPage = 1000,
         sort: initialSort,
-        setCustomFilter = (record: RecordType) => Boolean(record),
+        filterCallback = (record: RecordType) => Boolean(record),
     } = props;
     const resource = useResourceContext(props);
 
@@ -181,7 +181,7 @@ export const useList = <RecordType extends RaRecord = any>(
                             }
                         )
                     )
-                    .filter(setCustomFilter);
+                    .filter(filterCallback);
             }
             const filteredLength = tempData.length;
 
@@ -273,7 +273,7 @@ export interface UseListOptions<RecordType extends RaRecord = any> {
     perPage?: number;
     sort?: SortPayload;
     resource?: string;
-    setCustomFilter?: (record: RecordType) => boolean;
+    filterCallback?: (record: RecordType) => boolean;
 }
 
 export type UseListValue<