@docx-editor.dev/i18n 2.21.1 → 2.23.0

package/README.md

@@ -14,7 +14,7 @@
 
 # @docx-editor.dev/i18n
 
-Locale strings, types, and runtime helpers for the [docx-editor.dev](https://docx-editor.dev) editor chrome. Ten languages, with per-key fallback to English.
+Translate [docx-editor.dev](https://docx-editor.dev) controls with locale strings, types, and runtime helpers. The package provides eleven languages and falls back to English for missing translations.
 
 ## Quick start
 
@@ -28,12 +28,14 @@ Pass a locale to the editor. This example requires the React adapter and its eng
 
 ```tsx
 import { DocxEditor } from '@docx-editor.dev/react';
-import { de } from '@docx-editor.dev/i18n';
+import { es } from '@docx-editor.dev/i18n';
 
-<DocxEditor document={bytes} i18n={de} />;
+<DocxEditor document={bytes} i18n={es} locale="es-ES" />;
 ```
 
-For several editors, or for chrome parts you compose yourself, put it in context once with `LocaleProvider` instead:
+The `i18n` prop translates controls. Set `locale` separately for regional date input and generated document labels. It defaults to `en-US`.
+
+To share a locale across editors and custom controls, use `LocaleProvider`:
 
 ```tsx
 import { DocxEditor, LocaleProvider } from '@docx-editor.dev/react';
@@ -44,7 +46,7 @@ import { de } from '@docx-editor.dev/i18n';
 </LocaleProvider>;
 ```
 
-Chrome you write yourself reads the same catalog through `useTranslation()`.
+Custom controls read the same catalog through `useTranslation()`.
 
 Mix a community locale with custom overrides:
 
@@ -57,19 +59,7 @@ const myLocale = {
 };
 ```
 
-Keys set to `null` in any locale fall back to English.
-
-## Packages
-
-| Package | Description |
-| --- | --- |
-| [`@docx-editor.dev/react`](https://www.npmjs.com/package/@docx-editor.dev/react) | React adapter. `<DocxEditor>`, provider primitives, hooks, and compound chrome. |
-| [`@docx-editor.dev/core`](https://www.npmjs.com/package/@docx-editor.dev/core) | Framework-agnostic engine: OOXML read/write, canonical document tree, layout, paint. |
-| [`@docx-editor.dev/i18n`](https://www.npmjs.com/package/@docx-editor.dev/i18n) | Shared locale strings and types. |
-| [`@docx-editor.dev/pro`](https://www.npmjs.com/package/@docx-editor.dev/pro) | Tracked changes, comments, and custom nodes. |
-| [`@docx-editor.dev/editor-api`](https://www.npmjs.com/package/@docx-editor.dev/editor-api) | A supported subset of the Word Office.js API for server and browser editing. |
-
-If you fork an adapter, keep `@docx-editor.dev/core` as a peer dependency to receive engine fixes.
+Missing or `null` keys keep the inherited catalog value. Without an outer `LocaleProvider`, they fall back to English.
 
 ## Available locales
 
@@ -77,6 +67,7 @@ If you fork an adapter, keep `@docx-editor.dev/core` as a peer dependency to rec
 | ------- | ------ | ------------------- |
 | `en`    | `en`   | English (source)    |
 | `de`    | `de`   | German              |
+| `es`    | `es`   | Spanish             |
 | `fr`    | `fr`   | French              |
 | `he`    | `he`   | Hebrew              |
 | `hi`    | `hi`   | Hindi               |
@@ -96,7 +87,7 @@ import { locales } from '@docx-editor.dev/i18n';
 </LocaleProvider>;
 ```
 
-> Importing `locales` pulls every locale into your bundle. For a smaller bundle, import only the ones you need by name; `sideEffects: false` lets the rest tree-shake.
+Importing `locales` includes every locale in your bundle. Import individual locales to reduce the bundle size.
 
 ## Per-locale subpaths
 
@@ -113,7 +104,7 @@ For on-demand loading, use a dynamic import instead:
 const pl = (await import('@docx-editor.dev/i18n/pl')).default;
 ```
 
-Subpaths ship for every locale: `/en`, `/de`, `/fr`, `/he`, `/hi`, `/id`, `/pl`, `/pt-BR`, `/tr`, `/zh-CN`. Each also exports its locale as a named binding (`import { pl } from '@docx-editor.dev/i18n/pl'`) for callers that prefer non-default imports.
+Subpaths ship for every locale: `/en`, `/de`, `/es`, `/fr`, `/he`, `/hi`, `/id`, `/pl`, `/pt-BR`, `/tr`, `/zh-CN`. Each also exports its locale as a named binding (`import { pl } from '@docx-editor.dev/i18n/pl'`) for callers that prefer non-default imports.
 
 ## Types