WIP - starting to implement I18n

gui/rpk-gui/package.json

@@ -31,11 +31,15 @@
     "@tiptap/extension-underline": "^2.11.7",
     "@tiptap/react": "^2.11.7",
     "@tiptap/starter-kit": "^2.11.7",
+    "i18next": "^25.0.1",
+    "i18next-browser-languagedetector": "^8.0.5",
+    "i18next-http-backend": "^3.0.2",
     "lodash": "^4.17.21",
     "mui-tiptap": "^1.18.1",
     "react": "^18.0.0",
     "react-dom": "^18.0.0",
     "react-hook-form": "^7.30.0",
+    "react-i18next": "^15.5.1",
     "react-router": "^7.0.2"
   },
   "devDependencies": {

gui/rpk-gui/public/locales/en/common.json

@@ -0,0 +1,7 @@
+{
+  "pages": {
+    "login": {
+      "title": "Sign in to your account"
+    }
+  }
+}

gui/rpk-gui/public/locales/fr/common.json

@@ -0,0 +1,7 @@
+{
+  "pages": {
+    "login": {
+      "title": "S'authentifier"
+    }
+  }
+}

gui/rpk-gui/src/App.tsx

@@ -1,4 +1,5 @@
-import { Authenticated, Refine } from "@refinedev/core";
+import { Authenticated, I18nProvider, Refine } from "@refinedev/core";
+import { useTranslation } from "react-i18next";
 
 import { RefineSnackbarProvider, useNotificationProvider } from "@refinedev/mui";
 
@@ -12,8 +13,8 @@ import routerBindings, {
   UnsavedChangesNotifier,
 } from "@refinedev/react-router";
 import { BrowserRouter, Outlet, Route, Routes } from "react-router";
-import { authProvider } from "./providers/auth-provider";
-import { dataProvider } from "./providers/data-provider";
+import authProvider from "./providers/auth-provider";
+import dataProvider from "./providers/data-provider";
 import { ColorModeContextProvider } from "./contexts/color-mode";
 import { Login } from "./components/auth/Login";
 import { Register } from "./components/auth/Register";
@@ -26,6 +27,15 @@ import { FirmRoutes } from "./pages/firm";
 import rpcTheme from "./theme";
 
 function App() {
+
+  const { t, i18n } = useTranslation();
+
+  const i18nProvider: I18nProvider = {
+    translate: (key: string, options?: any) => t(key, options) as string,
+    changeLocale: (lang: string) => i18n.changeLanguage(lang),
+    getLocale: () => i18n.language,
+  };
+
   return (
     <BrowserRouter>
       <ThemeProvider theme={rpcTheme}>
@@ -36,6 +46,7 @@ function App() {
             <Refine
               authProvider={authProvider}
               dataProvider={dataProvider}
+              i18nProvider={i18nProvider}
               notificationProvider={useNotificationProvider}
               routerProvider={routerBindings}
               options={{

gui/rpk-gui/src/components/header/index.tsx

@@ -18,10 +18,17 @@ import { FirmContext } from "../../contexts/FirmContext";
 import { Logout } from "../auth/Logout";
 import { IUser } from "../../interfaces";
 import MuiLink from "@mui/material/Link";
+import { useTranslation } from "react-i18next";
+import { useTranslation as useTranslationR } from "@refinedev/core";
+import { useSetLocale } from "@refinedev/core";
 
 export const Header: React.FC<RefineThemedLayoutV2HeaderProps> = ({
   sticky = true,
 }) => {
+  const { i18n } = useTranslation();
+  const { getLocale, changeLocale } = useTranslationR();
+  const currentLocale = getLocale();
+
   const collapsed = false;
   const { mode, setMode } = useContext(ColorModeContext);
   const { currentFirm } = useContext(FirmContext);
@@ -37,6 +44,16 @@ export const Header: React.FC<RefineThemedLayoutV2HeaderProps> = ({
     setAnchorEl(null);
   };
 
+  const [anchorIn, setAnchorIn] = React.useState<null | HTMLElement>(null);
+  const openI18nMenu = Boolean(anchorEl);
+  const handleOpenI18nMenu = (event: React.MouseEvent<HTMLButtonElement>) => {
+    setAnchorIn(event.currentTarget);
+  }
+  const handleCloseI18nMenu = () => {
+    setAnchorIn(null);
+  };
+
+
   return (
     <AppBar position={sticky ? "sticky" : "relative"}>
       <Toolbar>
@@ -132,7 +149,43 @@ export const Header: React.FC<RefineThemedLayoutV2HeaderProps> = ({
             {!user && (
               <Link to="/auth/login"><Button>Login</Button></Link>
             )}
-
+            <Button
+              id="i18n-button"
+              aria-controls={openI18nMenu ? 'i18n-menu' : undefined}
+              aria-haspopup="true"
+              aria-expanded={openI18nMenu ? 'true' : undefined}
+              onClick={handleOpenI18nMenu}>
+              <Typography
+                sx={{
+                  display: {
+                    xs: "none",
+                    sm: "inline-block",
+                  },
+                }}
+                variant="subtitle2"
+              >
+                {currentLocale}
+              </Typography>&nbsp;
+              <Avatar src={`/images/flags/${currentLocale}.svg`} alt={currentLocale}/>
+            </Button>
+            <Menu
+              id="i18n-menu"
+              open={openI18nMenu}
+              anchorEl={anchorIn}
+              onClose={handleCloseI18nMenu}
+            >
+              {[...(i18n.languages || [])].sort().map((lang: string) => (
+                <MenuItem
+                  key={lang}
+                  onClick={() => changeLocale(lang)}
+                >
+                  <span style={{ marginRight: 8 }}>
+                    <Avatar src={`/images/flags/${lang}.svg`} alt={lang}/>
+                  </span>
+                  {lang === "en" ? "English" : "Français"}
+                </MenuItem>
+              ))}
+            </Menu>
           </Stack>
         </Stack>
       </Toolbar>

gui/rpk-gui/src/i18n.tsx

@@ -0,0 +1,20 @@
+import i18n from "i18next";
+import { initReactI18next } from "react-i18next";
+import Backend from "i18next-http-backend";
+import detector from "i18next-browser-languagedetector";
+
+i18n
+  .use(Backend)
+  .use(detector)
+  .use(initReactI18next)
+  .init({
+    supportedLngs: ["en", "fr"],
+    backend: {
+      loadPath: "/locales/{{lng}}/{{ns}}.json", // locale files path
+    },
+    ns: ["common"],
+    defaultNS: "common",
+    fallbackLng: ["en", "fr"],
+  });
+
+export default i18n;

gui/rpk-gui/src/index.tsx

@@ -2,12 +2,15 @@ import React from "react";
 import { createRoot } from "react-dom/client";
 
 import App from "./App";
+import "./i18n";
 
 const container = document.getElementById("root") as HTMLElement;
 const root = createRoot(container);
 
 root.render(
   <React.StrictMode>
-    <App />
+    <React.Suspense fallback="loading">
+      <App />
+    </React.Suspense>
   </React.StrictMode>
 );

gui/rpk-gui/src/providers/auth-provider.tsx

@@ -9,7 +9,7 @@ const DISCORD_SCOPES = { "scopes": "identify email" }
 
 const DEFAULT_LOGIN_REDIRECT = "/hub"
 
-export const authProvider: AuthProvider = {
+const authProvider: AuthProvider = {
   login: async ({ providerName, email, password }) => {
     const to_param = findGetParameter("to");
     const redirect = to_param === null ? DEFAULT_LOGIN_REDIRECT : to_param
@@ -199,3 +199,5 @@ function findGetParameter(parameterName: string) {
         });
     return result;
 }
+
+export default authProvider;

gui/rpk-gui/src/providers/data-provider.tsx

@@ -2,7 +2,7 @@ import type { DataProvider, HttpError } from "@refinedev/core";
 
 const API_URL = "/api/v1";
 
-export const dataProvider: DataProvider = {
+const dataProvider: DataProvider = {
   getOne: async ({ resource, id, meta }) => {
     if (id === "") {
       return { data: undefined };
@@ -149,3 +149,5 @@ export const dataProvider: DataProvider = {
   // updateMany: () => { /* ... */ },
   // custom: () => { /* ... */ },
 };
+
+export default dataProvider;