sheet-i18n 0.2.6-canary.3 → 0.3.0-canary.3

package/README.md

@@ -222,9 +222,9 @@ export const { IntlProvider, useTranslation } = createI18nContext(i18nStore);
 import React from 'react';
 import { IntlProvider } from './i18nContext';
 
-const App = (currentLocale: string) => {
+const App = () => {
   return (
-    <IntlProvider currentLocale={currentLocale}>
+    <IntlProvider>
       <YourComponent />
     </IntlProvider>
   );
@@ -292,7 +292,7 @@ Generates React context, including the `IntlProvider` and `useTranslation`.
 
 #### Parameters:
 
-- **`i18nStore`**: Output of `createI18nStore`.
+- **`i18nStore`**: Instance of `I18nStore`.
 
 > ⚠️ Caveats:
 
@@ -309,15 +309,39 @@ const { IntlProvider, useTranslation } = createI18nContext(i18nStore);
 
 A React component to provide translations to child components.
 
-#### Props:
+#### Properties:
+
+- **`currentLocale`** (optional):
+
+  - A key representing the current locale to use for translations.
+  - If not provided, the user's preferred language is automatically detected based on their browser settings.
+  - Falls back to the default locale in **i18nStore** if the detected language is unsupported.
 
-- **`currentLocale`**: Key locale. This will determine which locale to use for translations data.
 - **`children`**: React children.
 
 #### Example:
 
 ```tsx
-<IntlProvider currentLocale="ko">{children}</IntlProvider>
+// Add currentLocale if you want to manually handle the locale
+
+// The example is Next.js app routing
+import { i18nStore } from './file-path-of-i18nStore-initiated';
+
+interface LayoutProps {
+  params: {
+    locale: Locale;
+  };
+}
+
+export default function Layout({
+  children,
+  params,
+}: PropsWithChildren<PageProps>) {
+  const { defaultLocale } = i18nStore;
+  const currentLocale = params?.locale ?? defaultLocale;
+
+  return <IntlProvider currentLocale={currentLocale}>{children}</IntlProvider>;
+}
 ```
 
 ### `useTranslation`
@@ -369,25 +393,6 @@ Custom error messages help identify misconfigurations:
 2. **Missing Default Locale**: The `defaultLocale` must exist in `supportedLocales`.
 3. **Invalid LocaleSet**: Ensure the `localeSet` keys match `supportedLocales`.
 
-## 🌍 Example Usage in Applications
-
-```tsx
-import { useTranslation } from './i18nContext';
-
-const TableComponent = () => {
-  const { t } = useTranslation('header');
-
-  const columns = [
-    {
-      title: t('logout'),
-      dataIndex: 'action',
-    },
-  ];
-
-  return <Table columns={columns} />;
-};
-```
-
 ## 📜 Library Versions 🔢
 
 This package supports the following library versions:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sheet-i18n",
-  "version": "0.2.6-canary.3",
+  "version": "0.3.0-canary.3",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -32,13 +32,13 @@
   },
   "license": "ISC",
   "dependencies": {
-    "@sheet-i18n/exporter": "0.2.3-canary.1",
-    "@sheet-i18n/react": "0.1.2-canary.3"
+    "@sheet-i18n/exporter": "0.3.0-canary.1",
+    "@sheet-i18n/react": "0.2.0-canary.3"
   },
   "devDependencies": {
     "tsup": "^6.0.0",
     "typescript": "^5.0.0",
-    "@sheet-i18n/typescript-config": "0.2.3-canary.1"
+    "@sheet-i18n/typescript-config": "0.3.0-canary.1"
   },
   "scripts": {
     "build": "tsup",