@docx-editor.dev/i18n 2.20.0 → 2.21.1

package/README.md

@@ -16,13 +16,15 @@
 
 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.
 
-## Quick Start
+## Quick start
+
+Install the locale package:
 
 ```bash
 npm install @docx-editor.dev/i18n
 ```
 
-Hand the catalog to the editor:
+Pass a locale to the editor. This example requires the React adapter and its engine peer:
 
 ```tsx
 import { DocxEditor } from '@docx-editor.dev/react';
@@ -31,14 +33,13 @@ import { de } from '@docx-editor.dev/i18n';
 <DocxEditor document={bytes} i18n={de} />;
 ```
 
-For several editors, or for chrome parts you compose yourself, put it in context once with
-`LocaleProvider` instead:
+For several editors, or for chrome parts you compose yourself, put it in context once with `LocaleProvider` instead:
 
 ```tsx
 import { DocxEditor, LocaleProvider } from '@docx-editor.dev/react';
+import { de } from '@docx-editor.dev/i18n';
 
 <LocaleProvider i18n={de}>
-  <DocxEditor.Toolbar />
   <DocxEditor document={bytes} />
 </LocaleProvider>;
 ```
@@ -52,7 +53,7 @@ import { de } from '@docx-editor.dev/i18n';
 
 const myLocale = {
   ...de,
-  toolbar: { ...de.toolbar, bold: 'Fettdruck' },
+  formattingBar: { ...de.formattingBar, bold: 'Fettdruck' },
 };
 ```
 
@@ -60,15 +61,15 @@ 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) | Office.js-compatible editing API: a batching object model, on a server or against an open editor. |
+| 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. |
 
-> **Forking the adapter?** Keep your fork thin. Depend on `@docx-editor.dev/core` directly so parser, serializer, and rendering fixes land in your build automatically, without backporting each upstream change by hand.
+If you fork an adapter, keep `@docx-editor.dev/core` as a peer dependency to receive engine fixes.
 
 ## Available locales
 
@@ -99,13 +100,16 @@ import { locales } from '@docx-editor.dev/i18n';
 
 ## Per-locale subpaths
 
-For apps that pick the locale at runtime, the named exports above don't tree-shake — the bundler can't know which locale wins, so it ships them all. Use the per-locale subpaths instead. Each one bundles a single locale (~30KB) and code-splits cleanly:
+If you choose a locale at runtime, import its subpath to load only that locale. Static imports include it in the bundle. Dynamic imports let the bundler create a separate chunk:
 
 ```ts
-// Static — bundler ships only this locale's strings
+// Static import: include only this locale's strings.
 import pl from '@docx-editor.dev/i18n/pl';
+```
 
-// Dynamic — splits into its own chunk, loaded on demand
+For on-demand loading, use a dynamic import instead:
+
+```ts
 const pl = (await import('@docx-editor.dev/i18n/pl')).default;
 ```
 
@@ -113,6 +117,8 @@ Subpaths ship for every locale: `/en`, `/de`, `/fr`, `/he`, `/hi`, `/id`, `/pl`,
 
 ## Types
 
+Import types to describe locale data and translation functions:
+
 ```ts
 import type {
   LocaleStrings, // shape of `en`, the full source of truth
@@ -141,9 +147,8 @@ t('navigation.find.total', { total: 15 }); // ICU plurals
 
 ## Contributing
 
-Contributions welcome. See [CONTRIBUTING.md](https://github.com/eigenpal/docx-editor/blob/main/CONTRIBUTING.md) for setup, tests, and the one-time CLA signature.
+To contribute, see [CONTRIBUTING.md](https://github.com/eigenpal/docx-editor/blob/main/CONTRIBUTING.md) for setup, tests, and the one-time CLA signature.
 
-## Commercial Support
+## Commercial support
 
-> [!TIP]
-> Questions or custom features? Email **[docx-editor@eigenpal.com](mailto:docx-editor@eigenpal.com)**.
+For commercial support or custom features, [email the support team](mailto:docx-editor@eigenpal.com).

package/dist/de.js

@@ -620,6 +620,14 @@ var de_default = {
       start: null,
       strike: null,
       underline: null
+    },
+    structuralDetails: {
+      cellDelete: null,
+      cellInsert: null,
+      cellMerge: null,
+      numberingInsert: null,
+      rowDelete: null,
+      rowInsert: null
     }
   },
   toc: {
@@ -706,7 +714,18 @@ var de_default = {
       picture: "Bild",
       plainText: "Nur Text",
       repeatingSection: "Wiederholungsabschnitt",
-      richText: "Rich Text"
+      richText: "Rich Text",
+      buildingBlockGallery: null
+    },
+    calendar: {
+      nextMonth: null,
+      previousMonth: null,
+      today: null,
+      month: null,
+      year: null
+    },
+    gallery: {
+      empty: null
     }
   },
   notes: {
@@ -753,7 +772,8 @@ var de_default = {
     displayForReview: null,
     noMarkup: null,
     original: null,
-    protectDocument: null
+    protectDocument: null,
+    simpleMarkup: null
   },
   imageAltText: {
     description: "Beschreibung",

package/dist/de.mjs

@@ -593,6 +593,14 @@ var de_default = {
       start: null,
       strike: null,
       underline: null
+    },
+    structuralDetails: {
+      cellDelete: null,
+      cellInsert: null,
+      cellMerge: null,
+      numberingInsert: null,
+      rowDelete: null,
+      rowInsert: null
     }
   },
   toc: {
@@ -679,7 +687,18 @@ var de_default = {
       picture: "Bild",
       plainText: "Nur Text",
       repeatingSection: "Wiederholungsabschnitt",
-      richText: "Rich Text"
+      richText: "Rich Text",
+      buildingBlockGallery: null
+    },
+    calendar: {
+      nextMonth: null,
+      previousMonth: null,
+      today: null,
+      month: null,
+      year: null
+    },
+    gallery: {
+      empty: null
     }
   },
   notes: {
@@ -726,7 +745,8 @@ var de_default = {
     displayForReview: null,
     noMarkup: null,
     original: null,
-    protectDocument: null
+    protectDocument: null,
+    simpleMarkup: null
   },
   imageAltText: {
     description: "Beschreibung",

package/dist/en.js

@@ -427,6 +427,14 @@ var en_default = {
       single: "Single",
       double: "Double",
       auto: "Automatic"
+    },
+    structuralDetails: {
+      rowInsert: "Inserted table row",
+      rowDelete: "Deleted table row",
+      cellInsert: "Inserted table cell",
+      cellDelete: "Deleted table cell",
+      cellMerge: "Changed cell merge",
+      numberingInsert: "Inserted numbering reference"
     }
   },
   contextMenu: {
@@ -701,13 +709,24 @@ var en_default = {
       comboBox: "Combo box",
       date: "Date",
       picture: "Picture",
+      buildingBlockGallery: "Building block gallery",
       repeatingSection: "Repeating section"
     },
+    gallery: {
+      empty: "This document has no building blocks for this gallery."
+    },
     lock: {
       unlocked: "Unlocked",
       sdtLocked: "Content control locked",
       contentLocked: "Contents locked",
       sdtContentLocked: "Content control and contents locked"
+    },
+    calendar: {
+      today: "Today",
+      previousMonth: "Previous month",
+      nextMonth: "Next month",
+      month: "Month",
+      year: "Year"
     }
   },
   headerFooter: {
@@ -869,6 +888,7 @@ var en_default = {
   },
   review: {
     displayForReview: "Display for Review",
+    simpleMarkup: "Simple Markup",
     allMarkup: "All Markup",
     noMarkup: "No Markup",
     original: "Original",

package/dist/en.mjs

@@ -400,6 +400,14 @@ var en_default = {
       single: "Single",
       double: "Double",
       auto: "Automatic"
+    },
+    structuralDetails: {
+      rowInsert: "Inserted table row",
+      rowDelete: "Deleted table row",
+      cellInsert: "Inserted table cell",
+      cellDelete: "Deleted table cell",
+      cellMerge: "Changed cell merge",
+      numberingInsert: "Inserted numbering reference"
     }
   },
   contextMenu: {
@@ -674,13 +682,24 @@ var en_default = {
       comboBox: "Combo box",
       date: "Date",
       picture: "Picture",
+      buildingBlockGallery: "Building block gallery",
       repeatingSection: "Repeating section"
     },
+    gallery: {
+      empty: "This document has no building blocks for this gallery."
+    },
     lock: {
       unlocked: "Unlocked",
       sdtLocked: "Content control locked",
       contentLocked: "Contents locked",
       sdtContentLocked: "Content control and contents locked"
+    },
+    calendar: {
+      today: "Today",
+      previousMonth: "Previous month",
+      nextMonth: "Next month",
+      month: "Month",
+      year: "Year"
     }
   },
   headerFooter: {
@@ -842,6 +861,7 @@ var en_default = {
   },
   review: {
     displayForReview: "Display for Review",
+    simpleMarkup: "Simple Markup",
     allMarkup: "All Markup",
     noMarkup: "No Markup",
     original: "Original",

package/dist/fr.js

@@ -620,6 +620,14 @@ var fr_default = {
       start: null,
       strike: null,
       underline: null
+    },
+    structuralDetails: {
+      cellDelete: null,
+      cellInsert: null,
+      cellMerge: null,
+      numberingInsert: null,
+      rowDelete: null,
+      rowInsert: null
     }
   },
   toc: {
@@ -706,7 +714,18 @@ var fr_default = {
       picture: "Image",
       plainText: "Texte",
       repeatingSection: "Section répétitive",
-      richText: "Texte enrichi"
+      richText: "Texte enrichi",
+      buildingBlockGallery: null
+    },
+    calendar: {
+      nextMonth: null,
+      previousMonth: null,
+      today: null,
+      month: null,
+      year: null
+    },
+    gallery: {
+      empty: null
     }
   },
   notes: {
@@ -753,7 +772,8 @@ var fr_default = {
     displayForReview: null,
     noMarkup: null,
     original: null,
-    protectDocument: null
+    protectDocument: null,
+    simpleMarkup: null
   },
   imageAltText: {
     description: "Description",

package/dist/fr.mjs

@@ -593,6 +593,14 @@ var fr_default = {
       start: null,
       strike: null,
       underline: null
+    },
+    structuralDetails: {
+      cellDelete: null,
+      cellInsert: null,
+      cellMerge: null,
+      numberingInsert: null,
+      rowDelete: null,
+      rowInsert: null
     }
   },
   toc: {
@@ -679,7 +687,18 @@ var fr_default = {
       picture: "Image",
       plainText: "Texte",
       repeatingSection: "Section répétitive",
-      richText: "Texte enrichi"
+      richText: "Texte enrichi",
+      buildingBlockGallery: null
+    },
+    calendar: {
+      nextMonth: null,
+      previousMonth: null,
+      today: null,
+      month: null,
+      year: null
+    },
+    gallery: {
+      empty: null
     }
   },
   notes: {
@@ -726,7 +745,8 @@ var fr_default = {
     displayForReview: null,
     noMarkup: null,
     original: null,
-    protectDocument: null
+    protectDocument: null,
+    simpleMarkup: null
   },
   imageAltText: {
     description: "Description",

package/dist/he.js

@@ -620,6 +620,14 @@ var he_default = {
       start: null,
       strike: null,
       underline: null
+    },
+    structuralDetails: {
+      cellDelete: null,
+      cellInsert: null,
+      cellMerge: null,
+      numberingInsert: null,
+      rowDelete: null,
+      rowInsert: null
     }
   },
   toc: {
@@ -706,7 +714,18 @@ var he_default = {
       picture: "תמונה",
       plainText: "טקסט רגיל",
       repeatingSection: "מקטע חוזר",
-      richText: "טקסט מעוצב"
+      richText: "טקסט מעוצב",
+      buildingBlockGallery: null
+    },
+    calendar: {
+      nextMonth: null,
+      previousMonth: null,
+      today: null,
+      month: null,
+      year: null
+    },
+    gallery: {
+      empty: null
     }
   },
   notes: {
@@ -753,7 +772,8 @@ var he_default = {
     displayForReview: null,
     noMarkup: null,
     original: null,
-    protectDocument: null
+    protectDocument: null,
+    simpleMarkup: null
   },
   imageAltText: {
     description: "תיאור",

package/dist/he.mjs

@@ -593,6 +593,14 @@ var he_default = {
       start: null,
       strike: null,
       underline: null
+    },
+    structuralDetails: {
+      cellDelete: null,
+      cellInsert: null,
+      cellMerge: null,
+      numberingInsert: null,
+      rowDelete: null,
+      rowInsert: null
     }
   },
   toc: {
@@ -679,7 +687,18 @@ var he_default = {
       picture: "תמונה",
       plainText: "טקסט רגיל",
       repeatingSection: "מקטע חוזר",
-      richText: "טקסט מעוצב"
+      richText: "טקסט מעוצב",
+      buildingBlockGallery: null
+    },
+    calendar: {
+      nextMonth: null,
+      previousMonth: null,
+      today: null,
+      month: null,
+      year: null
+    },
+    gallery: {
+      empty: null
     }
   },
   notes: {
@@ -726,7 +745,8 @@ var he_default = {
     displayForReview: null,
     noMarkup: null,
     original: null,
-    protectDocument: null
+    protectDocument: null,
+    simpleMarkup: null
   },
   imageAltText: {
     description: "תיאור",

package/dist/hi.js

@@ -620,6 +620,14 @@ var hi_default = {
       start: null,
       strike: null,
       underline: null
+    },
+    structuralDetails: {
+      cellDelete: null,
+      cellInsert: null,
+      cellMerge: null,
+      numberingInsert: null,
+      rowDelete: null,
+      rowInsert: null
     }
   },
   toc: {
@@ -706,7 +714,18 @@ var hi_default = {
       picture: "चित्र",
       plainText: "सादा पाठ",
       repeatingSection: "दोहराया जाने वाला अनुभाग",
-      richText: "रिच टेक्स्ट"
+      richText: "रिच टेक्स्ट",
+      buildingBlockGallery: null
+    },
+    calendar: {
+      nextMonth: null,
+      previousMonth: null,
+      today: null,
+      month: null,
+      year: null
+    },
+    gallery: {
+      empty: null
     }
   },
   notes: {
@@ -753,7 +772,8 @@ var hi_default = {
     displayForReview: null,
     noMarkup: null,
     original: null,
-    protectDocument: null
+    protectDocument: null,
+    simpleMarkup: null
   },
   imageAltText: {
     description: "विवरण",

package/dist/hi.mjs

@@ -593,6 +593,14 @@ var hi_default = {
       start: null,
       strike: null,
       underline: null
+    },
+    structuralDetails: {
+      cellDelete: null,
+      cellInsert: null,
+      cellMerge: null,
+      numberingInsert: null,
+      rowDelete: null,
+      rowInsert: null
     }
   },
   toc: {
@@ -679,7 +687,18 @@ var hi_default = {
       picture: "चित्र",
       plainText: "सादा पाठ",
       repeatingSection: "दोहराया जाने वाला अनुभाग",
-      richText: "रिच टेक्स्ट"
+      richText: "रिच टेक्स्ट",
+      buildingBlockGallery: null
+    },
+    calendar: {
+      nextMonth: null,
+      previousMonth: null,
+      today: null,
+      month: null,
+      year: null
+    },
+    gallery: {
+      empty: null
     }
   },
   notes: {
@@ -726,7 +745,8 @@ var hi_default = {
     displayForReview: null,
     noMarkup: null,
     original: null,
-    protectDocument: null
+    protectDocument: null,
+    simpleMarkup: null
   },
   imageAltText: {
     description: "विवरण",

package/dist/id.js

@@ -394,6 +394,14 @@ var id_default = {
       start: null,
       strike: null,
       underline: null
+    },
+    structuralDetails: {
+      cellDelete: null,
+      cellInsert: null,
+      cellMerge: null,
+      numberingInsert: null,
+      rowDelete: null,
+      rowInsert: null
     }
   },
   contextMenu: {
@@ -706,7 +714,18 @@ var id_default = {
       picture: "Gambar",
       plainText: "Teks biasa",
       repeatingSection: "Bagian berulang",
-      richText: "Teks kaya"
+      richText: "Teks kaya",
+      buildingBlockGallery: null
+    },
+    calendar: {
+      nextMonth: null,
+      previousMonth: null,
+      today: null,
+      month: null,
+      year: null
+    },
+    gallery: {
+      empty: null
     }
   },
   notes: {
@@ -753,7 +772,8 @@ var id_default = {
     displayForReview: null,
     noMarkup: null,
     original: null,
-    protectDocument: null
+    protectDocument: null,
+    simpleMarkup: null
   },
   imageAltText: {
     description: "Deskripsi",

package/dist/id.mjs

@@ -367,6 +367,14 @@ var id_default = {
       start: null,
       strike: null,
       underline: null
+    },
+    structuralDetails: {
+      cellDelete: null,
+      cellInsert: null,
+      cellMerge: null,
+      numberingInsert: null,
+      rowDelete: null,
+      rowInsert: null
     }
   },
   contextMenu: {
@@ -679,7 +687,18 @@ var id_default = {
       picture: "Gambar",
       plainText: "Teks biasa",
       repeatingSection: "Bagian berulang",
-      richText: "Teks kaya"
+      richText: "Teks kaya",
+      buildingBlockGallery: null
+    },
+    calendar: {
+      nextMonth: null,
+      previousMonth: null,
+      today: null,
+      month: null,
+      year: null
+    },
+    gallery: {
+      empty: null
     }
   },
   notes: {
@@ -726,7 +745,8 @@ var id_default = {
     displayForReview: null,
     noMarkup: null,
     original: null,
-    protectDocument: null
+    protectDocument: null,
+    simpleMarkup: null
   },
   imageAltText: {
     description: "Deskripsi",