@eigenpal/docx-editor-react 1.4.0 → 1.5.0

package/dist/index.d.ts

@@ -108,6 +108,28 @@ interface PagedEditorRef {
      * No-op if the layout isn't ready yet or pageNumber is out of range.
      */
     scrollToPage(pageNumber: number): void;
+    /**
+     * Scroll to the comment identified by `commentId` and select its range so
+     * the selection overlay highlights it. Resolves the id → PM range via the
+     * live comment marks; returns `false` (not a throw, not a silent no-op)
+     * when the id no longer resolves so the caller can surface a "location no
+     * longer exists" affordance.
+     */
+    scrollToCommentId(commentId: number): boolean;
+    /**
+     * Scroll to the tracked change identified by `revisionId` and select its
+     * range so the selection overlay highlights it. Resolves the id → PM range
+     * via the live tracked-change marks; returns `false` when the id no longer
+     * resolves (the change was accepted/rejected/deleted).
+     */
+    scrollToChangeId(revisionId: number): boolean;
+    /**
+     * Select the PM position range `[from, to]` so the selection overlay
+     * highlights it, and scroll its start into view. No-op for a malformed
+     * range or a `from` past the document end; `to` is clamped to the document
+     * size (raw caller positions, so out-of-range must not throw).
+     */
+    highlightRange(from: number, to: number): void;
     /**
      * Look up the persistent hidden HF PM EditorView for a given HeaderFooter
      * instance. Returns null when none is mounted (no document, or `hf` is not
@@ -360,6 +382,36 @@ interface DocxEditorRef {
      * @example ref.current?.scrollToPosition(42)
      */
     scrollToPosition: (pmPos: number) => void;
+    /**
+     * Scroll the paginated view to the comment with the given id and select its
+     * anchored range so the selection overlay highlights it. Resolves the id
+     * against the live comment marks at call time.
+     * @returns `false` when the id no longer resolves (the comment was deleted
+     *   or its anchored text removed between render and click), so the caller
+     *   can surface a "location no longer exists" affordance rather than
+     *   silently no-op'ing.
+     * @example ref.current?.scrollToCommentId(3)
+     */
+    scrollToCommentId: (commentId: number) => boolean;
+    /**
+     * Scroll the paginated view to the tracked change with the given Word
+     * revision `w:id` and select its range so the selection overlay highlights
+     * it. Resolves the id against the live tracked-change marks at call time
+     * (matching coalesced revisions the way the changes sidebar does).
+     * @returns `false` when the id no longer resolves (the change was
+     *   accepted, rejected, or deleted between render and click).
+     * @example ref.current?.scrollToChangeId(42)
+     */
+    scrollToChangeId: (revisionId: number) => boolean;
+    /**
+     * Select the ProseMirror position range `[from, to]` so the selection
+     * overlay highlights it, and scroll its start into view. The selection
+     * persists until it next changes (there is no auto-clearing flash). No-op
+     * for a malformed range or a `from` past the document end; `to` is clamped
+     * to the document size.
+     * @example ref.current?.highlightRange(10, 24)
+     */
+    highlightRange: (from: number, to: number) => void;
     /** Open print preview */
     openPrintPreview: () => void;
     /** Print the document directly */