@docx-editor.dev/vue 2.15.0 → 2.16.0

package/dist/index.d.cts

@@ -35,11 +35,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. Defaults to the active locale catalog. */
+    /** Live drawing and form-control labels. Defaults to the active catalogue. */
     translate?: (key: string, params?: Record<string, string | number>) => string;
     /** Construction-time capability modules. Later array changes need a remount. */
     modules?: readonly EditorModule[];
@@ -196,8 +197,8 @@ declare const DocxEditorRoot: vue.DefineComponent<vue.ExtractPropTypes<{
     fonts: _docx_editor_dev_core.FontConfiguration | _docx_editor_dev_core.FontConfigurationFragment | _docx_editor_dev_core.FontResolver | undefined;
     author: string;
     mode: "suggesting" | "edit" | "view";
-    imageDecodePort: ImageDecodePort;
     zoomMode: "auto" | ZoomMode;
+    imageDecodePort: ImageDecodePort;
     translate: ((key: string, params?: Record<string, string | number>) => string) | undefined;
     modules: readonly EditorModule[];
     tableInteractionLabel: ((key: "table.insertRowBelow" | "table.insertColumnRight") => string) | undefined;
@@ -1526,6 +1527,7 @@ declare const MenuRow: vue.DefineComponent<vue.ExtractPropTypes<{
     };
 }>> & Readonly<{}>, {
     title: string;
+    selected: boolean;
     slot: string;
     active: boolean;
     className: string;
@@ -1533,7 +1535,6 @@ declare const MenuRow: vue.DefineComponent<vue.ExtractPropTypes<{
         [key: string]: any;
     }>;
     disabled: boolean;
-    selected: boolean;
     onSelect: () => void;
     'data-slot': string;
     shortcut: string;
@@ -5195,8 +5196,9 @@ interface DocxEditorProps {
     zoom?: number;
     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;
@@ -5966,6 +5968,7 @@ interface PaginatedDocxEditorHandle {
     }): void;
     formatting(): SurfaceFormatting | null;
     sectionProperties(): SectionProperties | null;
+    /** Save pending form input. Throws for invalid values or an active edit. */
     save(): Uint8Array | null;
 }
 /** Vue name for the same contract React exports as `PaginatedDocxEditorExpose`. @public */

package/dist/index.d.ts

@@ -35,11 +35,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. Defaults to the active locale catalog. */
+    /** Live drawing and form-control labels. Defaults to the active catalogue. */
     translate?: (key: string, params?: Record<string, string | number>) => string;
     /** Construction-time capability modules. Later array changes need a remount. */
     modules?: readonly EditorModule[];
@@ -196,8 +197,8 @@ declare const DocxEditorRoot: vue.DefineComponent<vue.ExtractPropTypes<{
     fonts: _docx_editor_dev_core.FontConfiguration | _docx_editor_dev_core.FontConfigurationFragment | _docx_editor_dev_core.FontResolver | undefined;
     author: string;
     mode: "suggesting" | "edit" | "view";
-    imageDecodePort: ImageDecodePort;
     zoomMode: "auto" | ZoomMode;
+    imageDecodePort: ImageDecodePort;
     translate: ((key: string, params?: Record<string, string | number>) => string) | undefined;
     modules: readonly EditorModule[];
     tableInteractionLabel: ((key: "table.insertRowBelow" | "table.insertColumnRight") => string) | undefined;
@@ -1526,6 +1527,7 @@ declare const MenuRow: vue.DefineComponent<vue.ExtractPropTypes<{
     };
 }>> & Readonly<{}>, {
     title: string;
+    selected: boolean;
     slot: string;
     active: boolean;
     className: string;
@@ -1533,7 +1535,6 @@ declare const MenuRow: vue.DefineComponent<vue.ExtractPropTypes<{
         [key: string]: any;
     }>;
     disabled: boolean;
-    selected: boolean;
     onSelect: () => void;
     'data-slot': string;
     shortcut: string;
@@ -5195,8 +5196,9 @@ interface DocxEditorProps {
     zoom?: number;
     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;
@@ -5966,6 +5968,7 @@ interface PaginatedDocxEditorHandle {
     }): void;
     formatting(): SurfaceFormatting | null;
     sectionProperties(): SectionProperties | null;
+    /** Save pending form input. Throws for invalid values or an active edit. */
     save(): Uint8Array | null;
 }
 /** Vue name for the same contract React exports as `PaginatedDocxEditorExpose`. @public */