sheet-i18n 0.3.0-canary.3 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -13
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -26,10 +26,13 @@ It serves as a bridge between your translation data and your application, offeri
|
|
|
26
26
|
|
|
27
27
|
The `sheet-i18n` ecosystem is divided into two main packages:
|
|
28
28
|
|
|
29
|
+
- 🌍 `sheet-i18n/exporter`
|
|
30
|
+
- ⚛️ `sheet-i18n/react`
|
|
31
|
+
|
|
29
32
|
---
|
|
30
33
|
|
|
31
34
|
<details open>
|
|
32
|
-
<summary
|
|
35
|
+
<summary>🌍 Server Export Function - sheet-i18n/exporter</summary>
|
|
33
36
|
|
|
34
37
|
#### `sheet-i18n/exporter`
|
|
35
38
|
|
|
@@ -264,10 +267,10 @@ The `I18nStore` manages type-safe translation states, ensuring consistency acros
|
|
|
264
267
|
- **`localeSet`**: An object where keys match `supportedLocales`, and values are translation sets.
|
|
265
268
|
|
|
266
269
|
> ⚠️ Caveats:
|
|
267
|
-
|
|
268
|
-
1. `supportedLocales` must be an array of locale strings.
|
|
269
|
-
2. `defaultLocale` must exist in `supportedLocales`.
|
|
270
|
-
3. `localeSet` must be an object with keys matching `supportedLocales`.
|
|
270
|
+
>
|
|
271
|
+
> 1. `supportedLocales` must be an array of locale strings.
|
|
272
|
+
> 2. `defaultLocale` must exist in `supportedLocales`.
|
|
273
|
+
> 3. `localeSet` must be an object with keys matching `supportedLocales`.
|
|
271
274
|
|
|
272
275
|
#### Example:
|
|
273
276
|
|
|
@@ -295,9 +298,9 @@ Generates React context, including the `IntlProvider` and `useTranslation`.
|
|
|
295
298
|
- **`i18nStore`**: Instance of `I18nStore`.
|
|
296
299
|
|
|
297
300
|
> ⚠️ Caveats:
|
|
298
|
-
|
|
299
|
-
1. `i18nStore` passed to createI18nContext must be an instance of I18nStore.
|
|
300
|
-
2. custom object is not allowed to be passed to createI18nContext.
|
|
301
|
+
>
|
|
302
|
+
> 1. `i18nStore` passed to createI18nContext must be an instance of I18nStore.
|
|
303
|
+
> 2. custom object is not allowed to be passed to createI18nContext.
|
|
301
304
|
|
|
302
305
|
#### Example:
|
|
303
306
|
|
|
@@ -379,11 +382,11 @@ const translatedMessage = t('{username} shown', { username: 'John Doe' });
|
|
|
379
382
|
```
|
|
380
383
|
|
|
381
384
|
> 💡 Note: The values object can contain any type of data, including React components.
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
385
|
+
|
|
386
|
+
```tsx
|
|
387
|
+
// <Username /> shown
|
|
388
|
+
const translatedMessage = t('{username} shown', { username: <Username /> });
|
|
389
|
+
```
|
|
387
390
|
|
|
388
391
|
## 🛠 Error Handling
|
|
389
392
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "sheet-i18n",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"main": "./dist/index.js",
|
|
5
5
|
"module": "./dist/index.mjs",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -32,13 +32,13 @@
|
|
|
32
32
|
},
|
|
33
33
|
"license": "ISC",
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"@sheet-i18n/exporter": "
|
|
36
|
-
"@sheet-i18n/react": "0.2.0
|
|
35
|
+
"@sheet-i18n/exporter": "1.1.0",
|
|
36
|
+
"@sheet-i18n/react": "0.2.0"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
39
|
"tsup": "^6.0.0",
|
|
40
40
|
"typescript": "^5.0.0",
|
|
41
|
-
"@sheet-i18n/typescript-config": "
|
|
41
|
+
"@sheet-i18n/typescript-config": "1.1.0"
|
|
42
42
|
},
|
|
43
43
|
"scripts": {
|
|
44
44
|
"build": "tsup",
|