Skip to content

Commit d659a31

Browse files
committed
feat: react-query provider
Offers a global QueryClientProvider for a shell site.
1 parent ddb2af0 commit d659a31

File tree

4 files changed

+41
-1
lines changed

4 files changed

+41
-1
lines changed

docs/how_tos/migrate-frontend-app.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -716,6 +716,12 @@ frontend-app-account should use the supported language list from frontend-base,
716716
This would help it match the behavior of the footer's language dropdown.
717717

718718

719+
Upgrade react-query
720+
===================
721+
722+
If the MFE uses react-query version 4 or below, upgrade it to 5 as per [this guide](https://tanstack.com/query/latest/docs/framework/react/guides/migrating-to-v5).
723+
724+
719725
Removal of pubsub-js
720726
====================
721727

package-lock.json

Lines changed: 29 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,7 @@
140140
},
141141
"peerDependencies": {
142142
"@openedx/paragon": "^22.20.2",
143+
"@tanstack/react-query": "^5.81.2",
143144
"react": "^18.3.1",
144145
"react-dom": "^18.3.1",
145146
"react-redux": "^8.1.3",

shell/site.tsx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { StrictMode } from 'react';
22
import { createRoot } from 'react-dom/client';
33
import { RouterProvider } from 'react-router-dom';
4+
import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
45

56
import {
67
SITE_INIT_ERROR,
@@ -14,6 +15,7 @@ import messages from './i18n';
1415
import createRouter from './router/createRouter';
1516

1617
subscribe(SITE_READY, async () => {
18+
const queryClient = new QueryClient();
1719
const router = createRouter();
1820

1921
addAppConfigs();
@@ -22,7 +24,9 @@ subscribe(SITE_READY, async () => {
2224
const root = createRoot(document.getElementById('root') as HTMLElement);
2325
root.render(
2426
<StrictMode>
25-
<RouterProvider router={router} />,
27+
<QueryClientProvider client={queryClient}>
28+
<RouterProvider router={router} />,
29+
</QueryClientProvider>
2630
</StrictMode>
2731
);
2832
});

0 commit comments

Comments
 (0)