Skip to content

📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!

i18n to remix

Maksim Mrug203ca9392ca3
diff --git a/app/entry.client.tsx b/app/entry.client.tsx
index ef3398303..18ce3b51e 100644
--- a/app/entry.client.tsx
+++ b/app/entry.client.tsx
@@ -8,11 +8,97 @@ import { RemixBrowser } from '@remix-run/react'
import { startTransition, StrictMode } from 'react'
import { hydrateRoot } from 'react-dom/client'
-startTransition(() => {
- hydrateRoot(
- document,
- <StrictMode>
- <RemixBrowser />
- </StrictMode>,
- )
-})
+import i18next from 'i18next'
+import { I18nextProvider, initReactI18next } from 'react-i18next'
+import LanguageDetector from 'i18next-browser-languagedetector'
+import Backend from 'i18next-http-backend'
+import { getInitialNamespaces } from 'remix-i18next'
+import _isString from 'lodash/isString'
+import _includes from 'lodash/includes'
+import i18n from './i18n'
+
+import { whitelist, defaultLanguage } from './constants'
+import { setItem, getItem } from './utils/localstorage'
+
+async function hydrate() {
+ const lngDetector = new LanguageDetector()
+ lngDetector.addDetector({
+ name: 'customDetector',
+ lookup() {
+ if (window.localStorage) {
+ const lsLang = getItem('language')
+
+ if (_includes(whitelist, lsLang)) {
+ return lsLang
+ }
+
+ setItem('language', defaultLanguage)
+ setItem('i18nextLng', defaultLanguage)
+ }
+
+ const language = navigator.language || navigator.userLanguage
+
+ if (_isString(language)) {
+ const subLanguage = language.substring(0, 2)
+
+ if (_includes(whitelist, subLanguage)) {
+ return subLanguage
+ }
+ }
+
+ return defaultLanguage
+ },
+ })
+
+ // @ts-ignore
+ await i18next
+ .use(initReactI18next)
+ .use(lngDetector)
+ .use(Backend)
+ .init({
+ ...i18n,
+ backend: {
+ loadPath: '/locales/{{lng}}.json',
+ },
+ detection: {
+ order: ['querystring', 'customDetector', 'htmlTag'],
+ },
+ interpolation: {
+ escapeValue: false,
+ },
+ fallbackLng: defaultLanguage,
+ parseMissingKeyHandler: (key) => {
+ if (i18next.isInitialized) {
+ console.warn(`Missing translation for ${key}`)
+ }
+ return key
+ },
+ whitelist,
+ ns: getInitialNamespaces(),
+ defaultNS: 'common',
+ })
+
+ i18next.on('languageChanged', (lng) => {
+ document.documentElement.setAttribute('lang', lng)
+ setItem('language', lng)
+ })
+
+ startTransition(() => {
+ hydrateRoot(
+ document,
+ <I18nextProvider i18n={i18next}>
+ <StrictMode>
+ <RemixBrowser />
+ </StrictMode>
+ </I18nextProvider>,
+ )
+ })
+}
+
+if (window.requestIdleCallback) {
+ window.requestIdleCallback(hydrate)
+} else {
+ // Safari doesn't support requestIdleCallback
+ // https://caniuse.com/requestidlecallback
+ window.setTimeout(hydrate, 1)
+}
diff --git a/app/i18n.ts b/app/i18n.ts
new file mode 100644
index 000000000..67c04c647
--- /dev/null
+++ b/app/i18n.ts
@@ -0,0 +1,6 @@
+export default {
+ supportedLngs: ['en', 'de', 'el', 'es', 'fr', 'hi', 'it', 'pl', 'ru', 'sv', 'uk', 'ru', 'zh'],
+ fallbackLng: 'en',
+ defaultNS: 'common',
+ react: { useSuspense: false },
+}
diff --git a/app/i18next.js b/app/i18next.js
deleted file mode 100644
index ea346c016..000000000
--- a/app/i18next.js
+++ /dev/null
@@ -1,68 +0,0 @@
-import i18next from 'i18next'
-import LanguageDetector from 'i18next-browser-languagedetector'
-import backend from 'i18next-http-backend'
-import _isString from 'lodash/isString'
-import _includes from 'lodash/includes'
-import { whitelist, defaultLanguage } from 'redux/constants'
-import { setItem, getItem } from 'utils/localstorage'
-
-const lngDetector = new LanguageDetector()
-lngDetector.addDetector({
- name: 'customDetector',
- lookup() {
- if (window.localStorage) {
- const lsLang = getItem('language')
-
- if (_includes(whitelist, lsLang)) {
- return lsLang
- }
-
- setItem('language', defaultLanguage)
- setItem('i18nextLng', defaultLanguage)
- }
-
- const language = navigator.language || navigator.userLanguage
-
- if (_isString(language)) {
- const subLanguage = language.substring(0, 2)
-
- if (_includes(whitelist, subLanguage)) {
- return subLanguage
- }
- }
-
- return defaultLanguage
- },
-})
-
-i18next
- .use(backend)
- .use(lngDetector)
- .init({
- backend: {
- loadPath: '/locales/{{lng}}.json',
- },
- detection: {
- order: ['querystring', 'customDetector'],
- },
- interpolation: {
- escapeValue: false,
- },
- fallbackLng: defaultLanguage,
- parseMissingKeyHandler: (key) => {
- if (i18next.isInitialized) {
- console.warn(`Missing translation for ${key}`)
- }
- return key
- },
- whitelist,
- ns: ['common'],
- defaultNS: 'common',
- })
-
-i18next.on('languageChanged', (lng) => {
- document.documentElement.setAttribute('lang', lng)
- setItem('language', lng)
-})
-
-export default i18next
diff --git a/app/i18next.server.ts b/app/i18next.server.ts
new file mode 100644
index 000000000..ee66bf671
--- /dev/null
+++ b/app/i18next.server.ts
@@ -0,0 +1,25 @@
+import { RemixI18Next } from 'remix-i18next'
+import Backend from 'i18next-fs-backend'
+import { resolve } from 'node:path'
+import i18n from './i18n'
+
+const i18next = new RemixI18Next({
+ detection: {
+ supportedLanguages: i18n.supportedLngs,
+ fallbackLanguage: i18n.fallbackLng,
+ },
+ // This is the configuration for i18next used
+ // when translating messages server-side only
+ i18next: {
+ ...i18n,
+ backend: {
+ loadPath: resolve('./public/locales/{{lng}}/{{ns}}.json'),
+ },
+ },
+ // The backend you want to use to load the translations
+ // Tip: You could pass `resources` to the `i18next` configuration and avoid
+ // a backend here
+ backend: Backend,
+})
+
+export default i18next
diff --git a/package-lock.json b/package-lock.json
index 93a401d70..d1da7ab39 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -28,9 +28,10 @@
"file-saver": "^2.0.5",
"flatpickr": "^4.6.13",
"i18n-iso-countries": "^7.6.0",
- "i18next": "^22.4.15",
- "i18next-browser-languagedetector": "^7.0.1",
- "i18next-http-backend": "^2.2.0",
+ "i18next": "^22.5.0",
+ "i18next-browser-languagedetector": "^7.0.2",
+ "i18next-fs-backend": "^2.1.2",
+ "i18next-http-backend": "^2.2.1",
"isbot": "^3.6.8",
"jszip": "^3.10.1",
"lodash": "^4.17.21",
@@ -41,7 +42,7 @@
"react-flagkit": "^2.0.4",
"react-flatpickr": "^3.10.13",
"react-helmet-async": "^1.3.0",
- "react-i18next": "^12.2.2",
+ "react-i18next": "^12.3.1",
"react-outside-click-handler": "^1.3.0",
"react-qr-code": "^2.0.11",
"react-router-hash-link": "^2.4.3",
@@ -49,6 +50,7 @@
"react-snowfall": "^1.2.1",
"react-timezone-select": "^2.1.1",
"react-type-animation": "^3.0.1",
+ "remix-i18next": "^5.1.1",
"spacetime": "^7.4.3",
"swetrix": "^2.2.1",
"timezone-soft": "^1.4.1"
@@ -4196,6 +4198,11 @@
"node": ">=6.5"
}
},
+ "node_modules/accept-language-parser": {
+ "version": "1.5.0",
+ "resolved": "https://registry.npmjs.org/accept-language-parser/-/accept-language-parser-1.5.0.tgz",
+ "integrity": "sha512-QhyTbMLYo0BBGg1aWbeMG4ekWtds/31BrEU+DONOg/7ax23vxpL03Pb7/zBmha2v7vdD3AyzZVWBVGEZxKOXWw=="
+ },
"node_modules/accepts": {
"version": "1.3.8",
"resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz",
@@ -8177,8 +8184,7 @@
"node_modules/fast-deep-equal": {
"version": "3.1.3",
"resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz",
- "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==",
- "dev": true
+ "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q=="
},
"node_modules/fast-glob": {
"version": "3.2.11",
@@ -9144,6 +9150,11 @@
"@babel/runtime": "^7.19.4"
}
},
+ "node_modules/i18next-fs-backend": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/i18next-fs-backend/-/i18next-fs-backend-2.1.2.tgz",
+ "integrity": "sha512-y9vl8HC8b1ayqZELzKvaKgnphrxgbaGGSNQjPU0JoTVP1M3NI6C69SwiAAXi6xuF1FSySJG52EdQZdMUETlwRA=="
+ },
"node_modules/i18next-http-backend": {
"version": "2.2.1",
"resolved": "https://registry.npmjs.org/i18next-http-backend/-/i18next-http-backend-2.2.1.tgz",
@@ -9325,6 +9336,14 @@
"node": ">=12"
}
},
+ "node_modules/intl-parse-accept-language": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/intl-parse-accept-language/-/intl-parse-accept-language-1.0.0.tgz",
+ "integrity": "sha512-YFMSV91JNBOSjw1cOfw2tup6hDP7mkz+2AUV7W1L1AM6ntgI75qC1ZeFpjPGMrWp+upmBRTX2fJWQ8c7jsUWpA==",
+ "engines": {
+ "node": ">=14"
+ }
+ },
"node_modules/invariant": {
"version": "2.2.4",
"resolved": "https://registry.npmjs.org/invariant/-/invariant-2.2.4.tgz",
@@ -13103,6 +13122,24 @@
"url": "https://opencollective.com/unified"
}
},
+ "node_modules/remix-i18next": {
+ "version": "5.1.1",
+ "resolved": "https://registry.npmjs.org/remix-i18next/-/remix-i18next-5.1.1.tgz",
+ "integrity": "sha512-2a9YnbTtF4Povyo396AvK+1pwP+FFclwkOeJtpFENIX+D/nBggoUy17ARq5q8maza7zplfdHWNODwNBEyMIEzg==",
+ "dependencies": {
+ "accept-language-parser": "^1.5.0",
+ "intl-parse-accept-language": "^1.0.0",
+ "lru-cache": "^7.14.1",
+ "use-consistent-value": "^1.0.0"
+ },
+ "peerDependencies": {
+ "@remix-run/react": "^1.0.0",
+ "@remix-run/server-runtime": "^1.0.0",
+ "i18next": "^22.0.3",
+ "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
+ "react-i18next": "^12.0.0"
+ }
+ },
"node_modules/require-directory": {
"version": "2.1.1",
"resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz",
@@ -14736,6 +14773,20 @@
"punycode": "^2.1.0"
}
},
+ "node_modules/use-consistent-value": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/use-consistent-value/-/use-consistent-value-1.0.0.tgz",
+ "integrity": "sha512-enIOysu0IwqjafsUXvhZPajB6UYjxwu8w38xWaHLfVs1onIyg2c0DwPgcknxqO0TpYpAHXdFDXOp7Cs9HbTIkw==",
+ "dependencies": {
+ "fast-deep-equal": "^3.1.3"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "peerDependencies": {
+ "react": ">=16"
+ }
+ },
"node_modules/use-isomorphic-layout-effect": {
"version": "1.1.2",
"resolved": "https://registry.npmjs.org/use-isomorphic-layout-effect/-/use-isomorphic-layout-effect-1.1.2.tgz",
@@ -18107,6 +18158,11 @@
"event-target-shim": "^5.0.0"
}
},
+ "accept-language-parser": {
+ "version": "1.5.0",
+ "resolved": "https://registry.npmjs.org/accept-language-parser/-/accept-language-parser-1.5.0.tgz",
+ "integrity": "sha512-QhyTbMLYo0BBGg1aWbeMG4ekWtds/31BrEU+DONOg/7ax23vxpL03Pb7/zBmha2v7vdD3AyzZVWBVGEZxKOXWw=="
+ },
"accepts": {
"version": "1.3.8",
"resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz",
@@ -21048,8 +21104,7 @@
"fast-deep-equal": {
"version": "3.1.3",
"resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz",
- "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==",
- "dev": true
+ "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q=="
},
"fast-glob": {
"version": "3.2.11",
@@ -21772,6 +21827,11 @@
"@babel/runtime": "^7.19.4"
}
},
+ "i18next-fs-backend": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/i18next-fs-backend/-/i18next-fs-backend-2.1.2.tgz",
+ "integrity": "sha512-y9vl8HC8b1ayqZELzKvaKgnphrxgbaGGSNQjPU0JoTVP1M3NI6C69SwiAAXi6xuF1FSySJG52EdQZdMUETlwRA=="
+ },
"i18next-http-backend": {
"version": "2.2.1",
"resolved": "https://registry.npmjs.org/i18next-http-backend/-/i18next-http-backend-2.2.1.tgz",
@@ -21899,6 +21959,11 @@
"resolved": "https://registry.npmjs.org/internmap/-/internmap-2.0.3.tgz",
"integrity": "sha512-5Hh7Y1wQbvY5ooGgPbDaL5iYLAPzMTUrjMulskHLH6wnv/A+1q5rgEaiuqEjB+oxGXIVZs1FF+R/KPN3ZSQYYg=="
},
+ "intl-parse-accept-language": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/intl-parse-accept-language/-/intl-parse-accept-language-1.0.0.tgz",
+ "integrity": "sha512-YFMSV91JNBOSjw1cOfw2tup6hDP7mkz+2AUV7W1L1AM6ntgI75qC1ZeFpjPGMrWp+upmBRTX2fJWQ8c7jsUWpA=="
+ },
"invariant": {
"version": "2.2.4",
"resolved": "https://registry.npmjs.org/invariant/-/invariant-2.2.4.tgz",
@@ -24494,6 +24559,17 @@
"unified": "^10.0.0"
}
},
+ "remix-i18next": {
+ "version": "5.1.1",
+ "resolved": "https://registry.npmjs.org/remix-i18next/-/remix-i18next-5.1.1.tgz",
+ "integrity": "sha512-2a9YnbTtF4Povyo396AvK+1pwP+FFclwkOeJtpFENIX+D/nBggoUy17ARq5q8maza7zplfdHWNODwNBEyMIEzg==",
+ "requires": {
+ "accept-language-parser": "^1.5.0",
+ "intl-parse-accept-language": "^1.0.0",
+ "lru-cache": "^7.14.1",
+ "use-consistent-value": "^1.0.0"
+ }
+ },
"require-directory": {
"version": "2.1.1",
"resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz",
@@ -25727,6 +25803,14 @@
"punycode": "^2.1.0"
}
},
+ "use-consistent-value": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/use-consistent-value/-/use-consistent-value-1.0.0.tgz",
+ "integrity": "sha512-enIOysu0IwqjafsUXvhZPajB6UYjxwu8w38xWaHLfVs1onIyg2c0DwPgcknxqO0TpYpAHXdFDXOp7Cs9HbTIkw==",
+ "requires": {
+ "fast-deep-equal": "^3.1.3"
+ }
+ },
"use-isomorphic-layout-effect": {
"version": "1.1.2",
"resolved": "https://registry.npmjs.org/use-isomorphic-layout-effect/-/use-isomorphic-layout-effect-1.1.2.tgz",
diff --git a/package.json b/package.json
index 03acea949..e5a7b09ff 100644
--- a/package.json
+++ b/package.json
@@ -34,9 +34,10 @@
"file-saver": "^2.0.5",
"flatpickr": "^4.6.13",
"i18n-iso-countries": "^7.6.0",
- "i18next": "^22.4.15",
- "i18next-browser-languagedetector": "^7.0.1",
- "i18next-http-backend": "^2.2.0",
+ "i18next": "^22.5.0",
+ "i18next-browser-languagedetector": "^7.0.2",
+ "i18next-fs-backend": "^2.1.2",
+ "i18next-http-backend": "^2.2.1",
"isbot": "^3.6.8",
"jszip": "^3.10.1",
"lodash": "^4.17.21",
@@ -47,7 +48,7 @@
"react-flagkit": "^2.0.4",
"react-flatpickr": "^3.10.13",
"react-helmet-async": "^1.3.0",
- "react-i18next": "^12.2.2",
+ "react-i18next": "^12.3.1",
"react-outside-click-handler": "^1.3.0",
"react-qr-code": "^2.0.11",
"react-router-hash-link": "^2.4.3",
@@ -55,6 +56,7 @@
"react-snowfall": "^1.2.1",
"react-timezone-select": "^2.1.1",
"react-type-animation": "^3.0.1",
+ "remix-i18next": "^5.1.1",
"spacetime": "^7.4.3",
"swetrix": "^2.2.1",
"timezone-soft": "^1.4.1"