Merge pull request #9220 from marmelab/doc-list-actions-error

[Doc] Fix `<List actions>` example throws an error
marmelab · Aug 25, 2023 · 2a57294 · 2a57294
2 parents 33bfca4 + e526918
commit 2a57294
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/docs/List.md b/docs/List.md
@@ -110,8 +110,13 @@ const ListActions = () => (
     </TopToolbar>
 );
 
+const postFilters = [
+    <TextInput label="Search" source="q" alwaysOn />,
+    <TextInput label="Title" source="title" defaultValue="Hello, World!" />,
+];
+
 export const PostList = () => (
-    <List actions={<ListActions/>}>
+    <List actions={<ListActions/>} filters={postFilters}>
         <DatagridConfigurable>
             ...
         </DatagridConfigurable>

diff --git a/packages/ra-ui-materialui/src/list/filter/FilterButton.tsx b/packages/ra-ui-materialui/src/list/filter/FilterButton.tsx
@@ -57,7 +57,9 @@ export const FilterButton = (props: FilterButtonProps): JSX.Element => {
     const anchorEl = useRef();
 
     if (filters === undefined) {
-        throw new Error('FilterButton requires filters prop to be set');
+        throw new Error(
+            'The <FilterButton> component requires the <List filters> prop to be set'
+        );
     }
 
     const hiddenFilters = filters.filter(