docs: namespace concept of i18n-ally is different from that of i18next

hemengke1997 · Jun 1, 2024 · c5da3c0 · c5da3c0
1 parent 5a028d5
commit c5da3c0
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -90,8 +90,8 @@ i18next
   .use(initReactI18next)
   .init({
     resources: {}, // !!! important: No resources are added at initialization, otherwise what's lazy loading :)
-    nsSeparator: '.', // namespace separator. If you use `namespace`, you need to configure this
-    keySeparator: false, // key separator.
+    nsSeparator: '.',
+    keySeparator: '.',
     fallbackLng,
     detection: {
       lookupQuerystring: lookupTarget,
@@ -120,11 +120,11 @@ const { beforeLanguageChange } = i18nAlly({
   },
 })
 
-const _changeLanguage = i18next.changeLanguage
+const i18nextChangeLanguage = i18next.changeLanguage
 i18next.changeLanguage = async (lang: string, ...args) => {
   // Load resources before language change
   await beforeLanguageChange(lang)
-  return _changeLanguage(lang, ...args)
+  return i18nextChangeLanguage(lang, ...args)
 }
 ```
 

diff --git a/README.zh.md b/README.zh.md
@@ -88,8 +88,8 @@ await i18next
   .use(initReactI18next)
   .init({
     resources: {}, // !!! 初始化时不添加资源，不然何来懒加载:)
-    nsSeparator: '.', // 如果你使用namespace，就需要配置此项
-    keySeparator: false, // 或者你不使用namespace，可以配置此项为你的key分隔符
+    nsSeparator: '.',
+    keySeparator: '.',
     fallbackLng,
     detection: { // 探测浏览器语言
       lookupQuerystring: lookupTarget,
@@ -121,11 +121,11 @@ const { beforeLanguageChange } = i18nAlly({
   },
 })
 
-const _changeLanguage = i18next.changeLanguage
+const i18nextChangeLanguage = i18next.changeLanguage
 i18next.changeLanguage = async (lang: string, ...args) => {
   // 语言改变之前，先加载资源
   await beforeLanguageChange(lang)
-  return _changeLanguage(lang, ...args)
+  return i18nextChangeLanguage(lang, ...args)
 }
 ```
 

diff --git a/playground/spa-with-namespace/src/main.tsx b/playground/spa-with-namespace/src/main.tsx
@@ -21,7 +21,7 @@ i18next
     debug: import.meta.env.DEV,
     resources: {},
     nsSeparator: '.',
-    keySeparator: false,
+    keySeparator: '.',
     interpolation: {
       escapeValue: false,
     },

diff --git a/playground/vscode-setting/src/main.tsx b/playground/vscode-setting/src/main.tsx
@@ -21,7 +21,7 @@ i18next
     debug: import.meta.env.DEV,
     resources: {},
     nsSeparator: '.',
-    keySeparator: false,
+    keySeparator: '.',
     interpolation: {
       escapeValue: false,
     },