@docx-editor.dev/react 2.14.1 → 2.15.0

package/dist/index.d.mts

@@ -227,10 +227,9 @@ interface ReviewRailRegistry {
 declare const ReviewRailContext: react.Context<ReviewRailRegistry | null>;
 
 /**
- * Props for `DocxEditor.Root`. Creation parameters (`document`, `fonts`, `author`,
- * `locale`, and the initial `mode`/`zoom`) are sampled when the instance is created;
- * only `document` and `fonts` identity remount it. Later `mode` and `zoom` changes flow through
- * `Editor.setZoom` so edits, the caret, and the undo history survive.
+ * Props for `DocxEditor.Root`. Only `document`, `fonts`, and `imageDecodePort` identity remounts
+ * the editor. Later `author`, `locale`, `mode`, `translate`, `zoom`, and `zoomMode` changes use
+ * instance setters. `modules` is sampled at mount only.
  *
  * @public
  */
@@ -248,19 +247,22 @@ interface DocxEditorRootProps {
      * failures degrade to the fixed measurer and report through `onFontError`.
      */
     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;
-    /** Drawing refusal labels for painted placeholders; defaults to the active locale catalogue. */
+    /** Live drawing labels for painted placeholders; defaults to the active locale catalogue. */
     translate?: (key: string, params?: Record<string, string | number>) => string;
     /**
-     * Capability modules to register (`@docx-editor.dev/pro`'s review module,
-     * custom nodes, collaboration). Sampled at mount only, like `mode`: module registration is
-     * construction-time in the engine.
+     * Capability modules to register (`@docx-editor.dev/pro`'s review module, custom nodes,
+     * collaboration). Sampled at mount only because registration is construction-time.
      */
     modules?: readonly EditorModule[];
     /**
-     * The mode the editor opens in, matching the toolbar's three-state pill. Sampled at
-     * mount only.
+     * The host mode, matching the toolbar's three-state pill. Changes apply without a remount.
      *
      * `'edit'` opens in editing even when the document's `w:trackRevisions` asks for
      * tracked changes; `'suggesting'` opens in suggesting (needs a review module and an
@@ -2319,8 +2321,7 @@ interface DocxEditorProps {
      * Omitting it mounts NO document, which is not the same as an empty one. */
     document?: DocumentSource;
     /**
-     * The mode the editor opens in, matching the toolbar's three-state pill. Applied at
-     * mount only — not reactive; remount to change.
+     * The host mode, matching the toolbar's three-state pill. Changes apply without a remount.
      *
      * Defaults to `'edit'`: the packaged editor opens every document ready to type, even
      * one whose `w:trackRevisions` asks for tracked changes. Pass `'suggesting'` (needs
@@ -2339,11 +2340,15 @@ interface DocxEditorProps {
      * `{ type: 'fixed' }` opts out.
      */
     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;
     /**
-     * Capability modules to register (`@docx-editor.dev/pro`'s review module,
-     * custom nodes). Applied at mount only, like `mode`.
+     * Capability modules to register (`@docx-editor.dev/pro`'s review module, custom nodes).
+     * Applied at mount only.
      */
     modules?: readonly EditorModule[];
     /**

package/dist/index.d.ts

@@ -227,10 +227,9 @@ interface ReviewRailRegistry {
 declare const ReviewRailContext: react.Context<ReviewRailRegistry | null>;
 
 /**
- * Props for `DocxEditor.Root`. Creation parameters (`document`, `fonts`, `author`,
- * `locale`, and the initial `mode`/`zoom`) are sampled when the instance is created;
- * only `document` and `fonts` identity remount it. Later `mode` and `zoom` changes flow through
- * `Editor.setZoom` so edits, the caret, and the undo history survive.
+ * Props for `DocxEditor.Root`. Only `document`, `fonts`, and `imageDecodePort` identity remounts
+ * the editor. Later `author`, `locale`, `mode`, `translate`, `zoom`, and `zoomMode` changes use
+ * instance setters. `modules` is sampled at mount only.
  *
  * @public
  */
@@ -248,19 +247,22 @@ interface DocxEditorRootProps {
      * failures degrade to the fixed measurer and report through `onFontError`.
      */
     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;
-    /** Drawing refusal labels for painted placeholders; defaults to the active locale catalogue. */
+    /** Live drawing labels for painted placeholders; defaults to the active locale catalogue. */
     translate?: (key: string, params?: Record<string, string | number>) => string;
     /**
-     * Capability modules to register (`@docx-editor.dev/pro`'s review module,
-     * custom nodes, collaboration). Sampled at mount only, like `mode`: module registration is
-     * construction-time in the engine.
+     * Capability modules to register (`@docx-editor.dev/pro`'s review module, custom nodes,
+     * collaboration). Sampled at mount only because registration is construction-time.
      */
     modules?: readonly EditorModule[];
     /**
-     * The mode the editor opens in, matching the toolbar's three-state pill. Sampled at
-     * mount only.
+     * The host mode, matching the toolbar's three-state pill. Changes apply without a remount.
      *
      * `'edit'` opens in editing even when the document's `w:trackRevisions` asks for
      * tracked changes; `'suggesting'` opens in suggesting (needs a review module and an
@@ -2319,8 +2321,7 @@ interface DocxEditorProps {
      * Omitting it mounts NO document, which is not the same as an empty one. */
     document?: DocumentSource;
     /**
-     * The mode the editor opens in, matching the toolbar's three-state pill. Applied at
-     * mount only — not reactive; remount to change.
+     * The host mode, matching the toolbar's three-state pill. Changes apply without a remount.
      *
      * Defaults to `'edit'`: the packaged editor opens every document ready to type, even
      * one whose `w:trackRevisions` asks for tracked changes. Pass `'suggesting'` (needs
@@ -2339,11 +2340,15 @@ interface DocxEditorProps {
      * `{ type: 'fixed' }` opts out.
      */
     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;
     /**
-     * Capability modules to register (`@docx-editor.dev/pro`'s review module,
-     * custom nodes). Applied at mount only, like `mode`.
+     * Capability modules to register (`@docx-editor.dev/pro`'s review module, custom nodes).
+     * Applied at mount only.
      */
     modules?: readonly EditorModule[];
     /**