Skip to content

Update react-query depency to require at least v5.83 #10838

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jul 21, 2025
Merged

Update react-query depency to require at least v5.83 #10838

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2064847
Upgrade react-query
djhi Jul 15, 2025
fa92912
Document how to enable a list based on its params
djhi Jul 15, 2025
7fa11ed
Fix documentation
djhi Jul 16, 2025
045a823
Add a story for conditional list data fetching
djhi Jul 16, 2025
9c821ba
Add logs to story
djhi Jul 18, 2025
1d615df
Update documentation
djhi Jul 18, 2025
e124713
Improve code example
djhi Jul 21, 2025
b56aca9
Update changelog
djhi Jul 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion docs/List.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1190,12 +1190,27 @@ export const PostList = () => (
}
}}
>
{/* DataGrid */}
<WithListContext
render={context =>
context.filterValues.q == null ||
context.filterValues.q === '' ? (
Copy link
Contributor

@slax57 slax57 Jul 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Too bad you copied the wrong condition: in the docs the condition was q.length > 2 and not q !== '' 😅

<CardContentInner>
Type a search term to fetch data
</CardContentInner>
) : (
<Datagrid>
{/* your fields */}
</Datagrid>
)
}
/>
</List>
)
```
{% endraw %}

**Note**: Notice we display some custom UI when there is no filter. This is because otherwise, users would see the loading UI as Tanstack Query will set the `isPending` property of the underlying query to `true` if the query isn't enabled.

## Accessing Extra Response Data

If `dataProvider.getList()` returns additional metadata in the response under the `meta` key, you can access it in the list view using the `meta` property of the `ListContext`.
Expand Down
28 changes: 13 additions & 15 deletions packages/ra-ui-materialui/src/list/List.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
TestMemoryRouter,
DataProvider,
GetListParams,
WithListContext,
} from 'ra-core';
import fakeRestDataProvider from 'ra-data-fakerest';
import {
Expand Down Expand Up @@ -253,28 +254,25 @@ export const ConditionalDataFetching = () => (
},
}}
>
<ConditionalDataFetchingView />
<WithListContext
render={context =>
context.filterValues.q == null ||
context.filterValues.q === '' ? (
<CardContentInner>
Type a search term to fetch data
</CardContentInner>
) : (
<BookList />
)
}
/>
</List>
)}
/>
</Admin>
</TestMemoryRouter>
);

const ConditionalDataFetchingView = () => {
const context = useListContext();

if (context.filterValues.q == null || context.filterValues.q === '') {
return (
<CardContentInner>
Type a search term to fetch data
</CardContentInner>
);
}

return <BookList />;
};

export const Filter = () => (
<TestMemoryRouter initialEntries={['/books']}>
<Admin dataProvider={defaultDataProvider}>
Expand Down
Loading