@docx-editor.dev/vue 2.14.1 → 2.15.1

package/dist/index.d.cts

@@ -32,10 +32,18 @@ type DocxEditorChildren = VNode;
 interface DocxEditorRootProps {
     document?: DocumentSource;
     fonts?: FontConfiguration | FontConfigurationFragment | FontResolver;
+    /** 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.
+     */
     locale?: string;
+    /** Live drawing labels. Defaults to the active locale catalog. */
     translate?: (key: string, params?: Record<string, string | number>) => string;
+    /** Construction-time capability modules. Later array changes need a remount. */
     modules?: readonly EditorModule[];
+    /** Live host mode. Omit it to let document tracking settings select the mode. */
     mode?: 'edit' | 'view' | 'suggesting';
     zoom?: number;
     zoomMode?: ZoomMode | 'auto';
@@ -847,8 +855,8 @@ declare const ToolbarAction: vue.DefineComponent<vue.ExtractPropTypes<{
     onSelect?: ((...args: any[]) => any) | undefined;
 }>, {
     disabledReason: string;
-    class: string;
     active: boolean;
+    class: string;
     className: string;
     icon: VNode<vue.RendererNode, vue.RendererElement, {
         [key: string]: any;
@@ -5171,6 +5179,7 @@ type EditorMode = 'edit' | 'view' | 'suggesting';
 interface DocxEditorProps {
     fonts?: FontConfiguration | FontConfigurationFragment | FontResolver;
     colorMode?: 'light' | 'dark' | 'system';
+    /** Live resolver for chrome and drawing labels. */
     t?: (key: string, params?: Record<string, string | number>) => string;
     i18n?: Translations;
     chrome?: boolean;
@@ -5181,11 +5190,17 @@ interface DocxEditorProps {
     navigation?: boolean;
     rulers?: boolean;
     document?: DocumentSource;
+    /** Live host mode. */
     mode?: EditorMode;
     zoom?: number;
     zoomMode?: ZoomMode | 'auto';
+    /**
+     * Engine locale for engine-generated content, such as the table of contents title.
+     * Changes apply without a remount.
+     */
     locale?: string;
     author?: string;
+    /** Construction-time capability modules. Later array changes need a remount. */
     modules?: readonly EditorModule[];
     class?: string;
 }

package/dist/index.d.ts

@@ -32,10 +32,18 @@ type DocxEditorChildren = VNode;
 interface DocxEditorRootProps {
     document?: DocumentSource;
     fonts?: FontConfiguration | FontConfigurationFragment | FontResolver;
+    /** 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.
+     */
     locale?: string;
+    /** Live drawing labels. Defaults to the active locale catalog. */
     translate?: (key: string, params?: Record<string, string | number>) => string;
+    /** Construction-time capability modules. Later array changes need a remount. */
     modules?: readonly EditorModule[];
+    /** Live host mode. Omit it to let document tracking settings select the mode. */
     mode?: 'edit' | 'view' | 'suggesting';
     zoom?: number;
     zoomMode?: ZoomMode | 'auto';
@@ -847,8 +855,8 @@ declare const ToolbarAction: vue.DefineComponent<vue.ExtractPropTypes<{
     onSelect?: ((...args: any[]) => any) | undefined;
 }>, {
     disabledReason: string;
-    class: string;
     active: boolean;
+    class: string;
     className: string;
     icon: VNode<vue.RendererNode, vue.RendererElement, {
         [key: string]: any;
@@ -5171,6 +5179,7 @@ type EditorMode = 'edit' | 'view' | 'suggesting';
 interface DocxEditorProps {
     fonts?: FontConfiguration | FontConfigurationFragment | FontResolver;
     colorMode?: 'light' | 'dark' | 'system';
+    /** Live resolver for chrome and drawing labels. */
     t?: (key: string, params?: Record<string, string | number>) => string;
     i18n?: Translations;
     chrome?: boolean;
@@ -5181,11 +5190,17 @@ interface DocxEditorProps {
     navigation?: boolean;
     rulers?: boolean;
     document?: DocumentSource;
+    /** Live host mode. */
     mode?: EditorMode;
     zoom?: number;
     zoomMode?: ZoomMode | 'auto';
+    /**
+     * Engine locale for engine-generated content, such as the table of contents title.
+     * Changes apply without a remount.
+     */
     locale?: string;
     author?: string;
+    /** Construction-time capability modules. Later array changes need a remount. */
     modules?: readonly EditorModule[];
     class?: string;
 }