@extend-ai/react-docx 0.7.0-alpha.6 → 0.7.0-alpha.8

package/README.md

@@ -158,7 +158,7 @@ export function EditorExample() {
 
 ## Thumbnail Hook
 
-The library can expose page thumbnails from mounted viewer surfaces so you can build your own page strip, mini-map, or navigation UI.
+The library can expose page thumbnails so you can build your own page strip, mini-map, or navigation UI. Thumbnail painting can render from the live page surface when it is mounted, or from an offscreen one-page surface when viewer virtualization has unmounted that page.
 
 ```tsx
 import * as React from "react";
@@ -174,6 +174,11 @@ export function ThumbnailExample() {
     maxWidthPx: 160,
     maxHeightPx: 220,
     pixelRatio: 2,
+    minRasterIntervalMs: 40,
+    renderWindow: {
+      visiblePageIndexes: [0, 1, 2],
+      prefetchPageIndexes: [3, 4, 5],
+    },
   });
 
   return (
@@ -194,10 +199,7 @@ export function ThumbnailExample() {
         ))}
       </div>
 
-      <DocxEditorViewer
-        editor={editor}
-        pageVirtualization={{ enabled: false }}
-      />
+      <DocxEditorViewer editor={editor} />
     </div>
   );
 }
@@ -205,10 +207,11 @@ export function ThumbnailExample() {
 
 Notes:
 
-- Thumbnails are produced from mounted page DOM.
+- Thumbnail canvases can stay attached in a virtualized sidebar; only canvases you mount request paint work.
+- Use `renderWindow.visiblePageIndexes` for thumbnails currently visible in your sidebar, and `renderWindow.prefetchPageIndexes` to warm nearby pages after visible work.
+- `minRasterIntervalMs` controls repeat renders for the same canvas. Lower values are useful when the consumer already limits thumbnail work to a small visible window.
 - Thumbnail sizing is bounded by `maxWidthPx` and `maxHeightPx`, so downstream UIs can bias toward portrait thumbnail rails.
-- If page virtualization is enabled, offscreen pages can report `status: "unavailable"`.
-- For a full thumbnail rail, disable virtualization or manage the visible page range yourself.
+- Thumbnails use a direct layout/model canvas renderer first; if a page has no usable snapshot, the hook falls back to an isolated offscreen page surface.
 
 ## Useful Hooks