@file-viewer/docx 0.3.31 → 0.3.33

package/README.md

@@ -329,6 +329,21 @@ python3 -m http.server 8000
 
 The demo is self-contained for normal DOCX files, includes sample documents, page navigation, light/dark rendering and an options panel. TIFF support is loaded only when a document actually contains TIFF media.
 
+## Optional display targets
+
+Pass `exposeDisplayTargets: true` to `renderAsync` (or to both `parseAsync`
+and `renderDocument` when used separately) to expose paragraph identities as
+`data-office-target` attributes. The value is the OOXML part path followed by
+`#p:<w14:paraId>`, or `#xpath:<structural-path>` when no paragraph ID is stored.
+Repeated headers and split paragraph fragments may share an identity.
+
+This option is disabled by default and works with the matching Worker bundle.
+It adds read-only identity metadata, not an editing or document write-back API.
+An external display adapter may use it to locate rendered text. Reloading or
+repaginating the document can replace DOM nodes; adapters must reapply their
+own cached display state. Identities are scoped to the source package and are
+not guaranteed across structural edits to the original file.
+
 ## Notes on fidelity
 
 The renderer follows OOXML semantics and uses browser-native layout. It is designed for production preview and regression testing, not for claiming byte-for-byte or pixel-perfect identity with Microsoft Word's private layout engine. Use `LayoutSnapshot` and the supplied regression fixture to monitor the remaining differences that depend on browser fonts, font fallback and shaping engines.

package/dist/docx-preview.d.ts

@@ -1,4 +1,6 @@
 export interface Options {
+    /** Emit read-only part/paragraph identities for independent display adapters. Off by default. */
+    exposeDisplayTargets?: boolean;
     inWrapper: boolean;
     hideWrapperOnPrint: boolean;
     ignoreWidth: boolean;