@docx-editor.dev/react 2.15.0 → 2.16.0

package/dist/index.d.mts

@@ -250,11 +250,12 @@ interface DocxEditorRootProps {
     /** Author for later comments, replies, and tracked changes. Changes apply without a remount. */
     author?: string;
     /**
-     * Engine locale for engine-generated content, such as the table of contents title.
-     * Changes apply without a remount.
+     * BCP-47 locale for regional date input and engine-generated labels. Defaults to en-US.
+     * Changes apply to subsequent edits without a remount; stored date formats are preserved.
+     * For UI translations, wrap Root and its chrome in LocaleProvider with an i18n catalog.
      */
     locale?: string;
-    /** Live drawing labels for painted placeholders; defaults to the active locale catalogue. */
+    /** Live drawing and form-control labels; defaults to the active catalogue. */
     translate?: (key: string, params?: Record<string, string | number>) => string;
     /**
      * Capability modules to register (`@docx-editor.dev/pro`'s review module, custom nodes,
@@ -2228,8 +2229,8 @@ interface DocxEditorProps {
      *
      * Equivalent to wrapping this editor in `<LocaleProvider i18n={de}>`, which is still
      * the way to set one language for several editors at once — this prop overrides such a
-     * provider for this editor only. Unlike `locale`, which tells the ENGINE what language
-     * the document is in, this decides what the buttons say.
+     * provider for this editor only. `locale` separately selects regional date input and
+     * generated document labels; it does not select the UI language.
      *
      * Hold it at a stable identity: a catalogue written inline (`i18n={{ toolbar: … }}`) is
      * a new object every render, and the merged catalogue behind it is what the chrome
@@ -2341,8 +2342,9 @@ interface DocxEditorProps {
      */
     zoomMode?: ZoomMode | 'auto';
     /**
-     * Engine locale for engine-generated content, such as the table of contents title.
-     * Changes apply without a remount.
+     * BCP-47 locale for regional date input and engine-generated labels. Defaults to en-US.
+     * Changes apply to subsequent edits without a remount; stored date formats are preserved.
+     * UI translations are supplied separately through i18n.
      */
     locale?: string;
     author?: string;
@@ -3393,7 +3395,7 @@ interface PaginatedDocxEditorHandle {
     formatting(): SurfaceFormatting | null;
     /** The section the document declares — what a ruler is made of. */
     sectionProperties(): SectionProperties | null;
-    /** Serialize the current document. */
+    /** Save pending form input. Throws for invalid values or an active edit. */
     save(): Uint8Array | null;
 }
 /** Vue name for the same handle contract. @public */

package/dist/index.d.ts

@@ -250,11 +250,12 @@ interface DocxEditorRootProps {
     /** Author for later comments, replies, and tracked changes. Changes apply without a remount. */
     author?: string;
     /**
-     * Engine locale for engine-generated content, such as the table of contents title.
-     * Changes apply without a remount.
+     * BCP-47 locale for regional date input and engine-generated labels. Defaults to en-US.
+     * Changes apply to subsequent edits without a remount; stored date formats are preserved.
+     * For UI translations, wrap Root and its chrome in LocaleProvider with an i18n catalog.
      */
     locale?: string;
-    /** Live drawing labels for painted placeholders; defaults to the active locale catalogue. */
+    /** Live drawing and form-control labels; defaults to the active catalogue. */
     translate?: (key: string, params?: Record<string, string | number>) => string;
     /**
      * Capability modules to register (`@docx-editor.dev/pro`'s review module, custom nodes,
@@ -2228,8 +2229,8 @@ interface DocxEditorProps {
      *
      * Equivalent to wrapping this editor in `<LocaleProvider i18n={de}>`, which is still
      * the way to set one language for several editors at once — this prop overrides such a
-     * provider for this editor only. Unlike `locale`, which tells the ENGINE what language
-     * the document is in, this decides what the buttons say.
+     * provider for this editor only. `locale` separately selects regional date input and
+     * generated document labels; it does not select the UI language.
      *
      * Hold it at a stable identity: a catalogue written inline (`i18n={{ toolbar: … }}`) is
      * a new object every render, and the merged catalogue behind it is what the chrome
@@ -2341,8 +2342,9 @@ interface DocxEditorProps {
      */
     zoomMode?: ZoomMode | 'auto';
     /**
-     * Engine locale for engine-generated content, such as the table of contents title.
-     * Changes apply without a remount.
+     * BCP-47 locale for regional date input and engine-generated labels. Defaults to en-US.
+     * Changes apply to subsequent edits without a remount; stored date formats are preserved.
+     * UI translations are supplied separately through i18n.
      */
     locale?: string;
     author?: string;
@@ -3393,7 +3395,7 @@ interface PaginatedDocxEditorHandle {
     formatting(): SurfaceFormatting | null;
     /** The section the document declares — what a ruler is made of. */
     sectionProperties(): SectionProperties | null;
-    /** Serialize the current document. */
+    /** Save pending form input. Throws for invalid values or an active edit. */
     save(): Uint8Array | null;
 }
 /** Vue name for the same handle contract. @public */